Open 3D Engine AtomLyIntegration Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AZ::AtomBridge::AtomViewportInfoDisplayRequests Class Referenceabstract

This bus is used to request changes to the viewport info display overlay. More...

#include <AtomViewportInfoDisplayBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual ViewportInfoDisplayState GetDisplayState () const =0
 Gets the current viewport info overlay state.
 
virtual void SetDisplayState (ViewportInfoDisplayState state)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = EBusAddressPolicy::Single
 

Detailed Description

This bus is used to request changes to the viewport info display overlay.

Member Function Documentation

◆ SetDisplayState()

virtual void AZ::AtomBridge::AtomViewportInfoDisplayRequests::SetDisplayState ( ViewportInfoDisplayState  state)
pure virtual

Sets the current viewport info overlay state. The overlay will be drawn to the default viewport context every frame, if enabled.

The documentation for this class was generated from the following file: