LyShine::IRenderGraph Class Reference

Inherited by LyShine::RenderGraph.

Public Member Functions
virtual	~IRenderGraph ()
	Virtual destructor.
virtual void	BeginMask (bool isMaskingEnabled, bool useAlphaTest, bool drawBehind, bool drawInFront)=0
	Begin the setup of a mask render node, primitives added between this call and StartChildrenForMask define the mask.
virtual void	StartChildrenForMask ()=0
	Start defining the children (masked primitives) of a mask.
virtual void	EndMask ()=0
	End the setup of a mask render node, this marks the end of adding child primitives.
virtual void	BeginRenderToTexture (AZ::Data::Instance< AZ::RPI::AttachmentImage > attachmentImage, const AZ::Vector2 &viewportTopLeft, const AZ::Vector2 &viewportSize, const AZ::Color &clearColor)=0
	Begin rendering to a texture.
virtual void	EndRenderToTexture ()=0
	End rendering to a texture.
virtual void	AddPrimitive (LyShine::UiPrimitive *primitive, const AZ::Data::Instance< AZ::RPI::Image > &texture, bool isClampTextureMode, bool isTextureSRGB, bool isTexturePremultipliedAlpha, BlendMode blendMode)=0
	Add an indexed triangle list primitive to the render graph with given render state.
virtual void	AddAlphaMaskPrimitive (LyShine::UiPrimitive *primitive, AZ::Data::Instance< AZ::RPI::AttachmentImage > contentAttachmentImage, AZ::Data::Instance< AZ::RPI::AttachmentImage > maskAttachmentImage, bool isClampTextureMode, bool isTextureSRGB, bool isTexturePremultipliedAlpha, BlendMode blendMode)=0
	Add an indexed triangle list primitive to the render graph which will use maskTexture as an alpha (gradient) mask.
virtual LyShine::UiPrimitive *	GetDynamicQuadPrimitive (const AZ::Vector2 *positions, uint32 packedColor)=0
virtual bool	IsRenderingToMask () const =0
	Get flag that indicates we are rendering into a mask. Used to avoid masks on child mask elements.
virtual void	SetIsRenderingToMask (bool isRenderingToMask)=0
	Set flag that we are rendering into a mask. Used to avoid masks on child mask elements.
virtual void	PushAlphaFade (float alphaFadeValue)=0
	Push an alpha fade, this is multiplied with any existing alpha fade from parents.
virtual void	PushOverrideAlphaFade (float alphaFadeValue)=0
	Push a new alpha fade value, this replaces any existing alpha fade.
virtual void	PopAlphaFade ()=0
	Pop an alpha fade off the stack.
virtual float	GetAlphaFade () const =0
	Get the current alpha fade value.

Member Function Documentation

AddAlphaMaskPrimitive()

virtual void LyShine::IRenderGraph::AddAlphaMaskPrimitive ( LyShine::UiPrimitive *  primitive, AZ::Data::Instance< AZ::RPI::AttachmentImage >  contentAttachmentImage, AZ::Data::Instance< AZ::RPI::AttachmentImage >  maskAttachmentImage, bool  isClampTextureMode, bool  isTextureSRGB, bool  isTexturePremultipliedAlpha, BlendMode  blendMode  )

pure virtual

Add an indexed triangle list primitive to the render graph which will use maskTexture as an alpha (gradient) mask.

Implemented in LyShine::RenderGraph.

AddPrimitive()

virtual void LyShine::IRenderGraph::AddPrimitive ( LyShine::UiPrimitive *  primitive, const AZ::Data::Instance< AZ::RPI::Image > &  texture, bool  isClampTextureMode, bool  isTextureSRGB, bool  isTexturePremultipliedAlpha, BlendMode  blendMode  )

pure virtual

Add an indexed triangle list primitive to the render graph with given render state.

Implemented in LyShine::RenderGraph.

BeginMask()

virtual void LyShine::IRenderGraph::BeginMask ( bool  isMaskingEnabled, bool  useAlphaTest, bool  drawBehind, bool  drawInFront  )

pure virtual

Begin the setup of a mask render node, primitives added between this call and StartChildrenForMask define the mask.

Implemented in LyShine::RenderGraph.

BeginRenderToTexture()

virtual void LyShine::IRenderGraph::BeginRenderToTexture ( AZ::Data::Instance< AZ::RPI::AttachmentImage >  attachmentImage, const AZ::Vector2 &  viewportTopLeft, const AZ::Vector2 &  viewportSize, const AZ::Color &  clearColor  )

pure virtual

Begin rendering to a texture.

Implemented in LyShine::RenderGraph.

EndMask()

virtual void LyShine::IRenderGraph::EndMask ( )

pure virtual

End the setup of a mask render node, this marks the end of adding child primitives.

Implemented in LyShine::RenderGraph.

EndRenderToTexture()

virtual void LyShine::IRenderGraph::EndRenderToTexture ( )

pure virtual

End rendering to a texture.

Implemented in LyShine::RenderGraph.

GetAlphaFade()

virtual float LyShine::IRenderGraph::GetAlphaFade ( ) const

pure virtual

Get the current alpha fade value.

Implemented in LyShine::RenderGraph.

GetDynamicQuadPrimitive()

virtual LyShine::UiPrimitive * LyShine::IRenderGraph::GetDynamicQuadPrimitive ( const AZ::Vector2 *  positions, uint32  packedColor  )

pure virtual

Get a dynamic quad primitive that can be added as an image primitive to the render graph The graph handles the allocation of this DynUiPrimitive and deletes it when the graph is reset This can be used if the UI component doesn't want to own the storage of the primitive. Used infrequently, e.g. for the selection rect on a text component.

Implemented in LyShine::RenderGraph.

IsRenderingToMask()

virtual bool LyShine::IRenderGraph::IsRenderingToMask ( ) const

pure virtual

Get flag that indicates we are rendering into a mask. Used to avoid masks on child mask elements.

Implemented in LyShine::RenderGraph.

PopAlphaFade()

virtual void LyShine::IRenderGraph::PopAlphaFade ( )

pure virtual

Pop an alpha fade off the stack.

Implemented in LyShine::RenderGraph.

PushAlphaFade()

virtual void LyShine::IRenderGraph::PushAlphaFade ( float  alphaFadeValue )

pure virtual

Push an alpha fade, this is multiplied with any existing alpha fade from parents.

Implemented in LyShine::RenderGraph.

PushOverrideAlphaFade()

virtual void LyShine::IRenderGraph::PushOverrideAlphaFade ( float  alphaFadeValue )

pure virtual

Push a new alpha fade value, this replaces any existing alpha fade.

Implemented in LyShine::RenderGraph.

SetIsRenderingToMask()

virtual void LyShine::IRenderGraph::SetIsRenderingToMask ( bool  isRenderingToMask )

pure virtual

Set flag that we are rendering into a mask. Used to avoid masks on child mask elements.

Implemented in LyShine::RenderGraph.

StartChildrenForMask()

virtual void LyShine::IRenderGraph::StartChildrenForMask ( )

pure virtual

Start defining the children (masked primitives) of a mask.

Implemented in LyShine::RenderGraph.

---

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

• Gems/LyShine/Code/Include/LyShine/IRenderGraph.h