Determines the semantic of a VertexElement. More...

#include <CeresEngine/Mesh/VertexDeclaration.hpp>

Inheritance diagram for CeresEngine::VertexElementSemantic:

Public Types
enum	: UnderlyingType { None , Position , Normal , TexCoord , Tangent , Bitangent , Color }
	The underlying raw value of `VertexElementSemantic`. More...

using	RawType = decltype(raw)

Public Types inherited from CeresEngine::StructEnum< VertexElementSemantic >
using	UnderlyingType = UInt32

using	Self = VertexElementSemantic

Public Member Functions
constexpr	VertexElementSemantic ()=default

constexpr	VertexElementSemantic (RawType raw)

constexpr	VertexElementSemantic (UnderlyingType raw)

StringView	toString () const noexcept
	Gets a string representation of `VertexElementSemantic`.

Public Member Functions inherited from CeresEngine::StructEnum< VertexElementSemantic >
	operator UnderlyingType () const noexcept
	Converts the enum into it's underlying type.

void	toString (std::ostream &stream) const noexcept
	Writes a string representation of the `ShaderType` to the given stream.

Static Public Member Functions
static Optional< VertexElementSemantic >	fromString (StringView string) noexcept
	Creates a new `VertexElementSemantic` from a string representation.

Static Public Member Functions inherited from CeresEngine::StructEnum< VertexElementSemantic >
static Self	fromRawUnderlying (UnderlyingType underlying) noexcept
	Creates a new `Self` from it's underlying numeric representation.

Public Attributes
enum CeresEngine::VertexElementSemantic:: { ... }	raw
	The underlying raw value of `VertexElementSemantic`.

Detailed Description

Determines the semantic of a VertexElement.

Member Typedef Documentation

◆ RawType

using CeresEngine::VertexElementSemantic::RawType = decltype(raw)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : UnderlyingType

The underlying raw value of VertexElementSemantic.

Enumerator
None	The vertex element should be ignored and don't represent anything.
Position	The vertex element represents the vertex position.
Normal	The vertex element represents the vertex normal vector.
TexCoord	The vertex element represents the vertex texture coordinate.
Tangent	The vertex element represents the vertex tangent vector.
Bitangent	The vertex element represents the vertex bi-tangent vector.
Color	The vertex element represents a vertex color channel.

Constructor & Destructor Documentation

◆ VertexElementSemantic() [1/3]

constexpr CeresEngine::VertexElementSemantic::VertexElementSemantic ( )

constexprdefault

◆ VertexElementSemantic() [2/3]

constexpr CeresEngine::VertexElementSemantic::VertexElementSemantic ( RawType raw )

inlineconstexpr

◆ VertexElementSemantic() [3/3]

constexpr CeresEngine::VertexElementSemantic::VertexElementSemantic ( UnderlyingType raw )

inlineexplicitconstexpr

Member Function Documentation

◆ fromString()

static Optional< VertexElementSemantic > CeresEngine::VertexElementSemantic::fromString ( StringView string )

staticnoexcept

Creates a new VertexElementSemantic from a string representation.

If the string value is invalid, an empty optional is returned.

◆ toString()

StringView CeresEngine::VertexElementSemantic::toString ( ) const

noexcept

Gets a string representation of VertexElementSemantic.

Member Data Documentation

◆ []

enum { ... } CeresEngine::VertexElementSemantic::raw