RenderPrototypeComponent Class Template

Component that stores the resource handles needed for rendering. More...

Declaration

template <typename TOwnerHandle> class helios::engine::rendering::common::components::RenderPrototypeComponent<TOwnerHandle> { ... }

Public Constructors Index

template <typename TOwnerHandle>
RenderPrototypeComponent (const ShaderHandle shaderHandle, const MaterialHandle materialHandle, const MeshHandle meshHandle)
	Constructs the component from explicit resource handles. More...
template <typename TOwnerHandle>
RenderPrototypeComponent (const ShaderEntity shader, const MaterialEntity material, const MeshEntity mesh)
	Constructs the component from resource entities. More...

Public Member Functions Index

template <typename TOwnerHandle>
MeshHandle	meshHandle () const noexcept
	Returns the mesh handle. More...
template <typename TOwnerHandle>
ShaderHandle	shaderHandle () const noexcept
	Returns the shader handle. More...
template <typename TOwnerHandle>
MaterialHandle	materialHandle () const noexcept
	Returns the material handle. More...
template <typename TOwnerHandle>
void	setMeshHandle (const MeshHandle meshHandle) noexcept
	Sets the mesh handle. More...
template <typename TOwnerHandle>
void	setShaderHandle (const ShaderHandle shaderHandle) noexcept
	Sets the shader handle. More...
template <typename TOwnerHandle>
void	setMaterialHandle (const MaterialHandle materialHandle) noexcept
	Sets the material handle. More...

Private Member Attributes Index

template <typename TOwnerHandle>
ShaderHandle	shaderHandle_
template <typename TOwnerHandle>
MaterialHandle	materialHandle_
template <typename TOwnerHandle>
MeshHandle	meshHandle_

Description

Component that stores the resource handles needed for rendering.

Template Parameters

TOwnerHandle

Owning entity handle type.

Definition at line 28 of file RenderPrototypeComponent.ixx.

Public Constructors

RenderPrototypeComponent()

template <typename TOwnerHandle>

helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::RenderPrototypeComponent (const ShaderHandle shaderHandle, const MaterialHandle materialHandle, const MeshHandle meshHandle)

inline explicit

Constructs the component from explicit resource handles.

Parameters

shaderHandle	Shader handle.
materialHandle	Material handle.
meshHandle	Mesh handle.

Definition at line 45 of file RenderPrototypeComponent.ixx.

45 explicit RenderPrototypeComponent(

46 const ShaderHandle shaderHandle,

47 const MaterialHandle materialHandle,

48 const MeshHandle meshHandle

49 )

50 : shaderHandle_(shaderHandle),

51 materialHandle_(materialHandle),

52 meshHandle_(meshHandle) {}

RenderPrototypeComponent()

template <typename TOwnerHandle>

helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::RenderPrototypeComponent (const ShaderEntity shader, const MaterialEntity material, const MeshEntity mesh)

inline explicit

Constructs the component from resource entities.

Parameters

shader	Shader entity.
material	Material entity.
mesh	Mesh entity.

Definition at line 61 of file RenderPrototypeComponent.ixx.

61 explicit RenderPrototypeComponent(

62 const ShaderEntity shader,

63 const MaterialEntity material,

64 const MeshEntity mesh

65 )

66 : shaderHandle_(shader.handle()),

67 materialHandle_(material.handle()),

68 meshHandle_(mesh.handle()) {}

Public Member Functions

materialHandle()

template <typename TOwnerHandle>

MaterialHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::materialHandle ()

inline noexcept

Returns the material handle.

Returns

Material resource handle.

Definition at line 93 of file RenderPrototypeComponent.ixx.

93 [[nodiscard]] MaterialHandle materialHandle() const noexcept {

94 return materialHandle_;

95 }

Referenced by helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setMaterialHandle.

meshHandle()

template <typename TOwnerHandle>

MeshHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::meshHandle ()

inline noexcept

Returns the mesh handle.

Returns

Mesh resource handle.

Definition at line 75 of file RenderPrototypeComponent.ixx.

75 [[nodiscard]] MeshHandle meshHandle() const noexcept {

76 return meshHandle_;

77 }

Referenced by helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setMeshHandle.

setMaterialHandle()

template <typename TOwnerHandle>

void helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setMaterialHandle (const MaterialHandle materialHandle)

inline noexcept

Sets the material handle.

Parameters

materialHandle

Material resource handle.

Definition at line 120 of file RenderPrototypeComponent.ixx.

120 void setMaterialHandle(const MaterialHandle materialHandle) noexcept {

121 materialHandle_ = materialHandle;

122 }

Reference helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::materialHandle.

setMeshHandle()

template <typename TOwnerHandle>

void helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setMeshHandle (const MeshHandle meshHandle)

inline noexcept

Sets the mesh handle.

Parameters

meshHandle

Mesh resource handle.

Definition at line 102 of file RenderPrototypeComponent.ixx.

102 void setMeshHandle(const MeshHandle meshHandle) noexcept {

103 meshHandle_ = meshHandle;

104 }

Reference helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::meshHandle.

setShaderHandle()

template <typename TOwnerHandle>

void helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setShaderHandle (const ShaderHandle shaderHandle)

inline noexcept

Sets the shader handle.

Parameters

shaderHandle

Shader resource handle.

Definition at line 111 of file RenderPrototypeComponent.ixx.

111 void setShaderHandle(const ShaderHandle shaderHandle) noexcept {

112 shaderHandle_ = shaderHandle;

113 }

Reference helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::shaderHandle.

shaderHandle()

template <typename TOwnerHandle>

ShaderHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::shaderHandle ()

inline noexcept

Returns the shader handle.

Returns

Shader resource handle.

Definition at line 84 of file RenderPrototypeComponent.ixx.

84 [[nodiscard]] ShaderHandle shaderHandle() const noexcept {

85 return shaderHandle_;

86 }

Referenced by helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::setShaderHandle.

Private Member Attributes

materialHandle_

template <typename TOwnerHandle>

MaterialHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::materialHandle_

Definition at line 32 of file RenderPrototypeComponent.ixx.

32 MaterialHandle materialHandle_;

meshHandle_

template <typename TOwnerHandle>

MeshHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::meshHandle_

Definition at line 34 of file RenderPrototypeComponent.ixx.

34 MeshHandle meshHandle_;

shaderHandle_

template <typename TOwnerHandle>

ShaderHandle helios::engine::rendering::common::components::RenderPrototypeComponent< TOwnerHandle >::shaderHandle_

Definition at line 30 of file RenderPrototypeComponent.ixx.

30 ShaderHandle shaderHandle_;

---

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

• RenderPrototypeComponent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.