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.
Classes | Public Member Functions | List of all members
AZ::AtomBridge::PerViewportDynamicDrawManager Class Referencefinal

Inherits AZ::AtomBridge::PerViewportDynamicDrawInterface.

Public Member Functions

 AZ_TYPE_INFO (PerViewportDynamicDrawManager, "{BED66185-00A7-43F7-BD28-C56BC8E4C535}")
 
void RegisterDynamicDrawContext (AZ::Name name, DrawContextFactory contextInitializer) override
 
void UnregisterDynamicDrawContext (AZ::Name name) override
 
RHI::Ptr< RPI::DynamicDrawContext > GetDynamicDrawContextForViewport (AZ::Name name, AzFramework::ViewportId viewportId) override
 
- Public Member Functions inherited from AZ::AtomBridge::PerViewportDynamicDrawInterface
 AZ_RTTI (PerViewportDynamicDrawInterface, "{1FF054F5-55FF-4ADB-A86D-640B15FA0395}")
 
virtual void RegisterDynamicDrawContext (AZ::Name name, DrawContextFactory contextInitializer)=0
 
virtual void UnregisterDynamicDrawContext (AZ::Name name)=0
 
virtual RHI::Ptr< RPI::DynamicDrawContext > GetDynamicDrawContextForViewport (AZ::Name name, AzFramework::ViewportId viewportId)=0
 

Additional Inherited Members

- Public Types inherited from AZ::AtomBridge::PerViewportDynamicDrawInterface
using DrawContextFactory = AZStd::function< void(RHI::Ptr< RPI::DynamicDrawContext >)>
 

Member Function Documentation

◆ GetDynamicDrawContextForViewport()

RHI::Ptr< RPI::DynamicDrawContext > AZ::AtomBridge::PerViewportDynamicDrawManager::GetDynamicDrawContextForViewport ( AZ::Name  name,
AzFramework::ViewportId  viewportId 
)
overridevirtual

Get a dynamic draw context associated with the specified viewport based on a factory registered with RegisterNamedDynamicDrawContext. This dynamic draw context will be created if it does not already exist.

Implements AZ::AtomBridge::PerViewportDynamicDrawInterface.

◆ RegisterDynamicDrawContext()

void AZ::AtomBridge::PerViewportDynamicDrawManager::RegisterDynamicDrawContext ( AZ::Name  name,
DrawContextFactory  contextInitializer 
)
overridevirtual

Register a named dynamic draw context that can be retrieved on a per-viewport basis. GetNamedDynamicDraw context can be called on a registered context name to retrieve a valid DynamicDrawContext for a given viewport.

Implements AZ::AtomBridge::PerViewportDynamicDrawInterface.

◆ UnregisterDynamicDrawContext()

void AZ::AtomBridge::PerViewportDynamicDrawManager::UnregisterDynamicDrawContext ( AZ::Name  name)
overridevirtual

Unregister a previously registered named per-viewport dynamic draw context. This will dispose of all dynamic draw contexts currently associated with this name.

Implements AZ::AtomBridge::PerViewportDynamicDrawInterface.

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