Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Static Public Attributes | List of all members
castor3d::MorphComponent Class Reference

#include <MorphComponent.hpp>

Inheritance diagram for castor3d::MorphComponent:
Inheritance graph
[legend]
Collaboration diagram for castor3d::MorphComponent:
Collaboration graph
[legend]

Public Member Functions

C3D_API MorphComponent (Submesh &submesh)
 Constructor. More...
 
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) override
 Gathers buffers that need to go in a vertex layout. More...
 
C3D_API SubmeshComponentSPtr clone (Submesh &submesh) const override
 
GpuBufferOffsetT< InterleavedVertex > const & getAnimationBuffer () const
 
GpuBufferOffsetT< InterleavedVertex > & getAnimationBuffer ()
 
bool isReady () const
 
InterleavedVertexArraygetData ()
 
ProgramFlags getProgramFlags (MaterialRPtr material) const override
 
- Public Member Functions inherited from castor3d::SubmeshComponent
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 ()
 

Static Public Attributes

static C3D_API castor::String const Name
 
static C3D_API uint32_t constexpr BindingPoint = 1u
 

Constructor & Destructor Documentation

◆ MorphComponent()

C3D_API castor3d::MorphComponent::MorphComponent ( Submesh submesh)
explicit

Constructor.

Parameters
[in]submeshThe parent submesh.

Member Function Documentation

◆ clone()

C3D_API SubmeshComponentSPtr castor3d::MorphComponent::clone ( Submesh submesh) const
overridevirtual

Returns
Clones this component into given submesh.
Parameters
[in,out]submeshReceives the cloned component.

Implements castor3d::SubmeshComponent.

◆ gather()

C3D_API void castor3d::MorphComponent::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 
)
overridevirtual

Gathers buffers that need to go in a vertex layout.

Parameters
[in]shaderFlagsThe shader flags.
[in]programFlagsThe program flags.
[in]materialThe material.
[in,out]buffersReceives the buffers.
[in,out]offsetsReceives the buffers offsets.
[in,out]layoutsReceives the vertex layouts.
[in]maskThe textures mask.
[in,out]currentLocationThe current attribute location.

Implements castor3d::SubmeshComponent.

◆ getAnimationBuffer() [1/2]

GpuBufferOffsetT< InterleavedVertex > & castor3d::MorphComponent::getAnimationBuffer ( )
inline

◆ getAnimationBuffer() [2/2]

GpuBufferOffsetT< InterleavedVertex > const & castor3d::MorphComponent::getAnimationBuffer ( ) const
inline

◆ getData()

InterleavedVertexArray & castor3d::MorphComponent::getData ( )
inline

◆ getProgramFlags()

ProgramFlags castor3d::MorphComponent::getProgramFlags ( MaterialRPtr  material) const
inlineoverridevirtual
Returns
The shader program flags.
Parameters
[in]materialThe material.

Implements castor3d::SubmeshComponent.

References castor3d::eMorphing.

◆ isReady()

bool castor3d::MorphComponent::isReady ( ) const
inline

Member Data Documentation

◆ BindingPoint

C3D_API uint32_t constexpr castor3d::MorphComponent::BindingPoint = 1u
staticconstexpr

◆ Name

C3D_API castor::String const castor3d::MorphComponent::Name
static

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