UiRenderControlInterface Class Reference

#include <UiRenderControlBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	Render (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

Detailed Description

The UiRenderControlBus is used for controlling the rendering of elements that affect the rendering of their children. An example use is a mask component that needs to setup stencil write before rendering its components to increment the stencil buffer, switch to stencil test before rendering the child elements and then do a second pass to decrement the stencil buffer. The interface is designed to be flexible and could also be used for setting up scissoring or rendering to a texture.

Member Function Documentation

Render()

virtual void UiRenderControlInterface::Render ( LyShine::IRenderGraph *  renderGraph, UiElementInterface *  elementInterface, UiRenderInterface *  renderInterface, int  numChildren, bool  isInGame  )

pure virtual

This renders this element plus its children. It allows the RenderControl element to control the order in which the element's component and children are rendered and to change state at any point while rendering them.

Parameters

renderGraph,the	render graph being added to
elementInterface,pointer	to the element interface for this element (for performance)
renderInterface,pointer	to the render interface for this element (for performance)
numChildren,the	number of child elements of this element
isInGame,true	if element being rendered in game (or preview), false if being render in edit mode

---

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

• Gems/LyShine/Code/Include/LyShine/Bus/UiRenderControlBus.h