AZ::RPI::PassData Struct Reference

#include <PassData.h>

Inherited by AZ::RPI::CopyPassData, AZ::RPI::DownsampleMipChainPassData, AZ::RPI::EnvironmentCubeMapPassData, AZ::RPI::RenderPassData, AZ::RPI::RenderToTexturePassData, AZ::Render::DisplayMapperPassData, and AZ::Render::EsmShadowmapsPassData.

Public Member Functions
	AZ_RTTI (PassData, "{F8594AE8-2588-4D64-89E5-B078A46A9AE4}")
	AZ_CLASS_ALLOCATOR (PassData, SystemAllocator)

Static Public Member Functions
static void	Reflect (ReflectContext *context)

Public Attributes
PipelineGlobalConnectionList	m_pipelineGlobalConnections
Name	m_pipelineViewTag
int	m_deviceIndex = RHI::MultiDevice::InvalidDeviceIndex
bool	m_mergeChildrenAsSubpasses = false
bool	m_canBecomeASubpass = true
	If the pass can be used as a subpass.

Detailed Description

Base class for custom data for Passes to be specified in a PassRequest or PassTemplate. If custom data is specified in both the PassTemplate and the PassRequest, the data specified in the PassRequest will take precedent and the data in PassTemplate ignored. All classes for custom pass data must inherit from this or one of it's derived classes.

Member Data Documentation

m_mergeChildrenAsSubpasses

bool AZ::RPI::PassData::m_mergeChildrenAsSubpasses = false

Only applicable for ParentPass. If set to "true" then: 0- You may get performance benefits if the GPU is a Tiled Based Rasterizer and the RHI supports TBR (like Vulkan). This is typically the case for Mobile and XR platforms. 1- All Child passes must be subclass of RenderPass and return true to CanBecomeSubpass(). 2- The Child passes will be considered as mergeable into sequential subpasses.

---

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

• Gems/Atom/RPI/Code/Include/Atom/RPI.Reflect/Pass/PassData.h