Specify rate at which vertex attributes are pulled from buffers. More...

#include <CeresEngine/RenderAPI/GPUVertexFormat.hpp>

Inheritance diagram for CeresEngine::GPUVertexInputRate:

Public Types
enum	: UnderlyingType { Vertex , Instance }
	The underlying raw value of `VertexElementSemantic`. More...

using	RawType = decltype(raw)

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

using	Self = GPUVertexInputRate

Public Member Functions
constexpr	GPUVertexInputRate ()=default

constexpr	GPUVertexInputRate (RawType raw)

constexpr	GPUVertexInputRate (UnderlyingType raw)

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

Public Member Functions inherited from CeresEngine::StructEnum< GPUVertexInputRate >
	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< GPUVertexInputRate >	fromString (StringView string) noexcept
	Creates a new `GPUVertexInputRate` from a string representation.

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

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

Detailed Description

Specify rate at which vertex attributes are pulled from buffers.

Member Typedef Documentation

◆ RawType

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : UnderlyingType

The underlying raw value of VertexElementSemantic.

Enumerator
Vertex	Specifies that vertex attribute addressing is a function of the vertex index.
Instance	Specifies that vertex attribute addressing is a function of the instance index.

Constructor & Destructor Documentation

◆ GPUVertexInputRate() [1/3]

constexpr CeresEngine::GPUVertexInputRate::GPUVertexInputRate ( )

constexprdefault

◆ GPUVertexInputRate() [2/3]

constexpr CeresEngine::GPUVertexInputRate::GPUVertexInputRate ( RawType raw )

inlineconstexpr

◆ GPUVertexInputRate() [3/3]

constexpr CeresEngine::GPUVertexInputRate::GPUVertexInputRate ( UnderlyingType raw )

inlineexplicitconstexpr

Member Function Documentation

◆ fromString()

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

staticnoexcept

Creates a new GPUVertexInputRate from a string representation.

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

◆ toString()

StringView CeresEngine::GPUVertexInputRate::toString ( ) const

noexcept

Gets a string representation of GPUVertexInputRate.

Member Data Documentation

◆ []

enum { ... } CeresEngine::GPUVertexInputRate::raw