InstanceRenderBatchContext Struct Template

Aggregates all state required to submit one instanced render batch. More...

Declaration

template <typename TMemberHandle> struct helios::engine::scene::types::InstanceRenderBatchContext<TMemberHandle> { ... }

Public Constructors Index

template <typename TMemberHandle>
InstanceRenderBatchContext (RenderTargetHandle renderTargetHdl, ViewportHandle viewportHdl, SceneHandle sceneHdl, MeshHandle meshHdl, MaterialHandle materialHdl, ShaderHandle shaderHdl)
	Constructs an instance batch context for a fixed render state tuple. More...

Public Member Attributes Index

template <typename TMemberHandle>
RenderTargetHandle	renderTargetHandle
	Target render target for rendering. More...
template <typename TMemberHandle>
ViewportHandle	viewportHandle
	Target viewport for rendering. More...
template <typename TMemberHandle>
SceneHandle	sceneHandle
	Owning scene handle. More...
template <typename TMemberHandle>
MeshHandle	meshHandle
	Mesh resource handle to render. More...
template <typename TMemberHandle>
MaterialHandle	materialHandle
	Material resource handle to apply. More...
template <typename TMemberHandle>
ShaderHandle	shaderHandle
	Shader resource handle used for draw submission. More...
template <typename TMemberHandle>
std::vector< TMemberHandle >	memberHandles
	Scene member handles contained in this instance batch. More...
template <typename TMemberHandle>
std::vector< InstanceData< TMemberHandle > >	instanceData
	Per-instance payload (for example model matrices) for draw submission. More...

Description

Aggregates all state required to submit one instanced render batch.

Template Parameters

TMemberHandle

Scene member/entity handle type.

Definition at line 40 of file InstanceRenderBatchContext.ixx.

Public Constructors

InstanceRenderBatchContext()

template <typename TMemberHandle>

helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::InstanceRenderBatchContext (RenderTargetHandle renderTargetHdl, ViewportHandle viewportHdl, SceneHandle sceneHdl, MeshHandle meshHdl, MaterialHandle materialHdl, ShaderHandle shaderHdl)

inline

Constructs an instance batch context for a fixed render state tuple.

Parameters

renderTargetHdl	Target render target handle.
viewportHdl	Target viewport handle.
sceneHdl	Owning scene handle.
meshHdl	Mesh handle used for the batch.
materialHdl	Material handle used for the batch.
shaderHdl	Shader handle used for the batch.

Definition at line 92 of file InstanceRenderBatchContext.ixx.

92 InstanceRenderBatchContext(

93 RenderTargetHandle renderTargetHdl,

94 ViewportHandle viewportHdl,

95 SceneHandle sceneHdl,

96 MeshHandle meshHdl,

97 MaterialHandle materialHdl,

98 ShaderHandle shaderHdl

99 ) : renderTargetHandle(renderTargetHdl),

100 viewportHandle(viewportHdl),

101 sceneHandle(sceneHdl),

102 meshHandle(meshHdl),

103 materialHandle(materialHdl),

104 shaderHandle(shaderHdl) {

105 memberHandles.reserve(DEFAULT_INSTANCE_DATA_CAPACITY);

106 instanceData.reserve(DEFAULT_INSTANCE_DATA_CAPACITY);

107 }

References DEFAULT_INSTANCE_DATA_CAPACITY, helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::instanceData and helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::memberHandles.

Public Member Attributes

instanceData

template <typename TMemberHandle>

std::vector<InstanceData<TMemberHandle> > helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::instanceData

Per-instance payload (for example model matrices) for draw submission.

Definition at line 80 of file InstanceRenderBatchContext.ixx.

80 std::vector<InstanceData<TMemberHandle>> instanceData;

Referenced by helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::InstanceRenderBatchContext.

materialHandle

template <typename TMemberHandle>

MaterialHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::materialHandle

Material resource handle to apply.

Definition at line 65 of file InstanceRenderBatchContext.ixx.

65 MaterialHandle materialHandle;

memberHandles

template <typename TMemberHandle>

std::vector<TMemberHandle> helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::memberHandles

Scene member handles contained in this instance batch.

Definition at line 75 of file InstanceRenderBatchContext.ixx.

75 std::vector<TMemberHandle> memberHandles;

Referenced by helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::InstanceRenderBatchContext.

meshHandle

template <typename TMemberHandle>

MeshHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::meshHandle

Mesh resource handle to render.

Definition at line 60 of file InstanceRenderBatchContext.ixx.

60 MeshHandle meshHandle;

renderTargetHandle

template <typename TMemberHandle>

RenderTargetHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::renderTargetHandle

Target render target for rendering.

Definition at line 45 of file InstanceRenderBatchContext.ixx.

45 RenderTargetHandle renderTargetHandle;

sceneHandle

template <typename TMemberHandle>

SceneHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::sceneHandle

Owning scene handle.

Definition at line 55 of file InstanceRenderBatchContext.ixx.

55 SceneHandle sceneHandle;

shaderHandle

template <typename TMemberHandle>

ShaderHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::shaderHandle

Shader resource handle used for draw submission.

Definition at line 70 of file InstanceRenderBatchContext.ixx.

70 ShaderHandle shaderHandle;

viewportHandle

template <typename TMemberHandle>

ViewportHandle helios::engine::scene::types::InstanceRenderBatchContext< TMemberHandle >::viewportHandle

Target viewport for rendering.

Definition at line 50 of file InstanceRenderBatchContext.ixx.

50 ViewportHandle viewportHandle;

---

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

• InstanceRenderBatchContext.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.