Open 3D Engine LyShine 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 | List of all members
LyShine::RenderToTextureRequests Class Referenceabstract

Ebus to handle render target requests. More...

#include <RenderToTextureBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual AZ::RHI::AttachmentId UseRenderTarget (const AZ::Name &renderTargetName, AZ::RHI::Size size)=0
 
virtual AZ::RHI::AttachmentId UseRenderTargetAsset (const AZ::Data::Asset< AZ::RPI::AttachmentImageAsset > &attachmentImageAsset)=0
 
virtual void ReleaseRenderTarget (const AZ::RHI::AttachmentId &attachmentId)=0
 Call when a render target is no longer needed by a UI canvas.
 
virtual AZ::Data::Instance< AZ::RPI::AttachmentImage > GetRenderTarget (const AZ::RHI::AttachmentId &attachmentId)=0
 Get an attachment image used by a UI canvas from an attachment image Id.
 

Detailed Description

Ebus to handle render target requests.

Member Function Documentation

◆ UseRenderTarget()

virtual AZ::RHI::AttachmentId LyShine::RenderToTextureRequests::UseRenderTarget ( const AZ::Name &  renderTargetName,
AZ::RHI::Size  size 
)
pure virtual

Get an attachment image to be used internally by a UI component to render to texture and then read that same texture (ex. UiMaskComponent, UiFaderComponent)

◆ UseRenderTargetAsset()

virtual AZ::RHI::AttachmentId LyShine::RenderToTextureRequests::UseRenderTargetAsset ( const AZ::Data::Asset< AZ::RPI::AttachmentImageAsset > &  attachmentImageAsset)
pure virtual

Get an attachment image from an attachment image asset to render to texture only and then read it outside of LyShine (ex. render UI canvas to a render target and use in a material)

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