castor3d::SubmeshComponent Class Reference

#include <SubmeshComponent.hpp>

Inheritance diagram for castor3d::SubmeshComponent:

Collaboration diagram for castor3d::SubmeshComponent:

Public Member Functions
C3D_API	SubmeshComponent (Submesh &submesh, castor::String const &type, uint32_t id)
	Constructor. More...
virtual C3D_API	~SubmeshComponent () noexcept=default
	Destructor. More...
C3D_API bool	initialise (RenderDevice const &device)
	Initialises the submesh. More...
C3D_API void	cleanup (RenderDevice const &device)
	Cleans the submesh. More...
C3D_API void	upload ()
	Uploads data on VRAM. More...
virtual C3D_API void	gather (ShaderFlags const &shaderFlags, ProgramFlags const &programFlags, MaterialRPtr material, ashes::BufferCRefArray &buffers, std::vector< uint64_t > &offsets, ashes::PipelineVertexInputStateCreateInfoCRefArray &layouts, TextureFlagsArray const &mask, uint32_t &currentLocation)=0
	Gathers buffers that need to go in a vertex layout. More...
virtual C3D_API ProgramFlags	getProgramFlags (MaterialRPtr material) const =0
virtual C3D_API VkBufferUsageFlags	getUsageFlags () const
virtual C3D_API SubmeshComponentSPtr	clone (Submesh &submesh) const =0
castor::String const &	getType () const
void	needsUpdate ()
	Sets the component to be updated. More...
uint32_t	getID ()

Constructor & Destructor Documentation

SubmeshComponent()

C3D_API castor3d::SubmeshComponent::SubmeshComponent	(	Submesh &	submesh,
		castor::String const &	type,
		uint32_t	id
	)

Constructor.

Parameters

[in]	submesh	The parent submesh.
[in]	type	The component type.
[in]	id	The component ID.

~SubmeshComponent()

virtual C3D_API castor3d::SubmeshComponent::~SubmeshComponent ( )

virtualdefaultnoexcept

Destructor.

Member Function Documentation

cleanup()

C3D_API void castor3d::SubmeshComponent::cleanup

(

RenderDevice const &

device

)

Cleans the submesh.

clone()

virtual C3D_API SubmeshComponentSPtr castor3d::SubmeshComponent::clone ( Submesh &  submesh ) const

pure virtual

Returns

Clones this component into given submesh.

Parameters

[in,out]

submesh

Receives the cloned component.

Implemented in castor3d::BonesComponent, castor3d::InstantiationComponent, castor3d::LinesMapping, castor3d::MorphComponent, castor3d::SecondaryUVComponent, and castor3d::TriFaceMapping.

gather()

virtual C3D_API void castor3d::SubmeshComponent::gather ( ShaderFlags const &  shaderFlags, ProgramFlags const &  programFlags, MaterialRPtr  material, ashes::BufferCRefArray &  buffers, std::vector< uint64_t > &  offsets, ashes::PipelineVertexInputStateCreateInfoCRefArray &  layouts, TextureFlagsArray const &  mask, uint32_t &  currentLocation  )

pure virtual

Gathers buffers that need to go in a vertex layout.

Parameters

[in]	shaderFlags	The shader flags.
[in]	programFlags	The program flags.
[in]	material	The material.
[in,out]	buffers	Receives the buffers.
[in,out]	offsets	Receives the buffers offsets.
[in,out]	layouts	Receives the vertex layouts.
[in]	mask	The textures mask.
[in,out]	currentLocation	The current attribute location.

Implemented in castor3d::BonesComponent, castor3d::IndexMapping, castor3d::InstantiationComponent, castor3d::MorphComponent, and castor3d::SecondaryUVComponent.

getID()

uint32_t castor3d::SubmeshComponent::getID ( )

inline

Returns

The component binding ID.

getProgramFlags()

virtual C3D_API ProgramFlags castor3d::SubmeshComponent::getProgramFlags ( MaterialRPtr  material ) const

pure virtual

Returns

The shader program flags.

Parameters

[in]

material

The material.

Implemented in castor3d::BonesComponent, castor3d::IndexMapping, castor3d::InstantiationComponent, castor3d::MorphComponent, and castor3d::SecondaryUVComponent.

getType()

castor::String const & castor3d::SubmeshComponent::getType ( ) const

inline

Returns

The component type name.

getUsageFlags()

virtual C3D_API VkBufferUsageFlags castor3d::SubmeshComponent::getUsageFlags ( ) const

inlinevirtual

Returns

The buffer usage flags.

Reimplemented in castor3d::IndexMapping.

initialise()

C3D_API bool castor3d::SubmeshComponent::initialise

(

RenderDevice const &

device

)

Initialises the submesh.

needsUpdate()

void castor3d::SubmeshComponent::needsUpdate ( )

inline

Sets the component to be updated.

Referenced by castor3d::InstantiationComponent::find().

Here is the caller graph for this function:

upload()

C3D_API void castor3d::SubmeshComponent::upload

(

)

Uploads data on VRAM.

Remarks

For host visible buffers.

---

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

• Model/Mesh/Submesh/Component/SubmeshComponent.hpp