castor3d::SkinningUbo Class Reference

#include <SkinningUbo.hpp>

Collaboration diagram for castor3d::SkinningUbo:

Public Types
using	Configuration = SkinningTransformsConfiguration

Static Public Member Functions
static C3D_API shader::SkinningData	declare (sdw::ShaderWriter &writer, uint32_t transformsBinding, uint32_t transformsSet, bool hasSkin)
	Declares the variables needed to compute skinning in vertex shader.
static C3D_API sdw::Mat4	computeTransform (shader::SkinningData const &data, sdw::Mat4 const &transform, sdw::ShaderWriter &writer, sdw::UInt const &skinningId, sdw::UVec4 const &boneIds0, sdw::UVec4 const &boneIds1, sdw::Vec4 const &boneWeights0, sdw::Vec4 const &boneWeights1)
	Computes skinning transformation in vertex shader.
template<ast::var::Flag FlagT>
static sdw::Mat4	computeTransform (shader::SkinningData const &data, shader::MeshVertexT< FlagT > const &surface, sdw::ShaderWriter &writer, sdw::Int const &instanceIndex, sdw::UVec4 const &boneIds0, sdw::UVec4 const &boneIds1, sdw::Vec4 const &boneWeights0, sdw::Vec4 const &boneWeights1)
	Computes skinning transformation in vertex shader.

Static Public Attributes
static C3D_API castor::MbString const	BufferSkinning

Member Typedef Documentation

Configuration

using castor3d::SkinningUbo::Configuration = SkinningTransformsConfiguration

Member Function Documentation

computeTransform() [1/2]

static C3D_API sdw::Mat4 castor3d::SkinningUbo::computeTransform ( shader::SkinningData const & data, sdw::Mat4 const & transform, sdw::ShaderWriter & writer, sdw::UInt const & skinningId, sdw::UVec4 const & boneIds0, sdw::UVec4 const & boneIds1, sdw::Vec4 const & boneWeights0, sdw::Vec4 const & boneWeights1 )

static

Computes skinning transformation in vertex shader.

Parameters

[in]	data	The skinning data.
[in]	transform	The pre-skinning transform.
[in]	writer	The shader writer.
[in]	skinningId	The node's skinning ID.
[in]	boneIds0	The bones IDs (0..3).
[in]	boneIds1	The bones IDs (4..7).
[in]	boneWeights0	The bones weights (0..3).
[in]	boneWeights1	The bones weights (4..7).

Returns

The resulting matrix.

Referenced by computeTransform().

Here is the caller graph for this function:

computeTransform() [2/2]

template<ast::var::Flag FlagT>

static sdw::Mat4 castor3d::SkinningUbo::computeTransform ( shader::SkinningData const & data, shader::MeshVertexT< FlagT > const & surface, sdw::ShaderWriter & writer, sdw::Int const & instanceIndex, sdw::UVec4 const & boneIds0, sdw::UVec4 const & boneIds1, sdw::Vec4 const & boneWeights0, sdw::Vec4 const & boneWeights1 )

inlinestatic

Computes skinning transformation in vertex shader.

Parameters

[in]	data	The skinning data.
[in]	surface	The processed surface
[in]	writer	The shader writer.
[in]	instanceIndex	The instance index.
[in]	boneIds0	The bones IDs (0..3).
[in]	boneIds1	The bones IDs (4..7).
[in]	boneWeights0	The bones weights (0..3).
[in]	boneWeights1	The bones weights (4..7).

Returns

The resulting matrix.

References computeTransform().

Here is the call graph for this function:

declare()

static C3D_API shader::SkinningData castor3d::SkinningUbo::declare ( sdw::ShaderWriter & writer, uint32_t transformsBinding, uint32_t transformsSet, bool hasSkin )

static

Declares the variables needed to compute skinning in vertex shader.

Parameters

[in]	writer	The shader writer.
[in]	transformsBinding	The descriptor set binding point for the transforms buffer.
[in]	transformsSet	The descriptor set index for the transforms buffer.
[in]	hasSkin	true to enable skinning.

Returns

The skinning data.

Member Data Documentation

BufferSkinning

C3D_API castor::MbString const castor3d::SkinningUbo::BufferSkinning

static

Name of the skinning animation frame variable buffer.

---

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

• Castor3D/Shader/Ubos/SkinningUbo.hpp