stim::mesh_indices_description struct

Initialization parameters for a mesh's indices.

Constructors, destructors, conversion operators

mesh_indices_description() defaulted noexcept: Default constructor. Does not initialize the members.
template<typename T> mesh_indices_description(const T* first_index, size_t index_count, size_t bytes_between_indices = sizeof(T)) constexpr noexcept: Constructs a mesh index description from a pointer to indices.
template<typename T, size_t Ex> mesh_indices_description(const span<T, Ex>& indices) constexpr noexcept: Constructs a mesh index description from a span of indices.
operator bool() const explicit constexpr noexcept: Returns true if the fields of this description are sufficient to describe a mesh's indices.

Public variables

const void* ptr: Pointer to the first index.
size_t count: The total number of indices in the mesh.
size_t stride: The number of bytes between indices.
scalar_type type: The fundamental data type of the individual indices.

Compatibility with UE4

template<typename T, typename Alloc> mesh_indices_description(const ::TArray<T, Alloc>& arr) noexcept: TArray constructor.
template<typename T, typename SizeType> mesh_indices_description(const ::TArrayView<T, SizeType>& view) noexcept: TArrayView constructor.
mesh_indices_description(const ::FRawStaticIndexBuffer& buffer) noexcept: Initializes the description from a UE4 index buffer.
mesh_indices_description(const ::FStaticMeshLODResources& lod) noexcept: Initializes the description from a single LOD of a UE4 static mesh.

Friends

auto operator!=(const mesh_indices_description& lhs, const mesh_indices_description& rhs) -> bool constexpr noexcept: Returns true if two descriptions do not describe the same mesh indices.
auto operator==(const mesh_indices_description& lhs, const mesh_indices_description& rhs) -> bool constexpr noexcept: Returns true if two descriptions describe the same mesh indices.

Function documentation

stim::mesh_indices_description::mesh_indices_description() defaulted noexcept

Default constructor. Does not initialize the members.

template<typename T>
stim::mesh_indices_description::mesh_indices_description(const T* first_index, size_t index_count, size_t bytes_between_indices = sizeof(T)) constexpr noexcept

Constructs a mesh index description from a pointer to indices.

Template parameters
T	The index type.
Parameters
first_index	Pointer to the index data.
index_count	The total number of indices in the mesh.
bytes_between_indices	The number of bytes between indices (stride).

template<typename T, size_t Ex>
stim::mesh_indices_description::mesh_indices_description(const span<T, Ex>& indices) constexpr noexcept

Constructs a mesh index description from a span of indices.

Template parameters
T	The index type.
Ex
Parameters
indices	Span of the index data.

template<typename T, typename Alloc>
stim::mesh_indices_description::mesh_indices_description(const ::TArray<T, Alloc>& arr) noexcept

TArray constructor.

template<typename T, typename SizeType>
stim::mesh_indices_description::mesh_indices_description(const ::TArrayView<T, SizeType>& view) noexcept

TArrayView constructor.

stim::mesh_indices_description::mesh_indices_description(const ::FRawStaticIndexBuffer& buffer) noexcept

Initializes the description from a UE4 index buffer.

stim::mesh_indices_description::mesh_indices_description(const ::FStaticMeshLODResources& lod) noexcept

Initializes the description from a single LOD of a UE4 static mesh.

Variable documentation

const void* stim::mesh_indices_description::ptr

Pointer to the first index.

size_t stim::mesh_indices_description::count

The total number of indices in the mesh.

size_t stim::mesh_indices_description::stride

The number of bytes between indices.

scalar_type stim::mesh_indices_description::type

The fundamental data type of the individual indices.