LiteFX::Math::Vector2u

A vector that contains two unsigned integers.

Synopsis

Declared in <litefx/math.hpp>

class [[dllexport, dllimport]] Vector2u
    : public Vector<UInt32, 2>

Base Classes

Name

Description

Vector<UInt32, 2>

An algebraic vector type. The value type of a vector must be in standard layout (i.e., std::is_standard_layout_v<T> must evaluate to true). This constraint is enforced at compile time and ensures that vector types can be binary marshaled. For example, the LiteFX::Graphics::Vertex type stores nothing more than a series of vectors. The standard layout constraint ensures that a set of vertices can be converted into a plain byte array and back.

Type Aliases

Name	Description
scalar_type	The type of the vector elements.
vec_type	The type of the vector itself.

Member Functions

Name	Description
Vector2u [constructor]	Constructors
operator=	Assignment operators
begin	Returns an interator for that addresses the begin of the vector elements.
cbegin	Returns a constant interator for that addresses the begin of the vector elements.
cend	Returns a constant interator for that addresses the end of the vector elements.
elements	Returns a pointer to the elements of the vector.
end	Returns an interator for that addresses the end of the vector elements.
operator[]	Subscript operators
size	Returns the number of dimensions of the vector.
w	w overloads
x	x overloads
y	y overloads
z	z overloads
operator DirectX::XMUINT2	Converts the vector into the type DirectX::XMUINT2.
operator DirectX::XMVECTOR	Converts the vector into the type DirectX::XMVECTOR.
operator glm::u32vec2	Converts the vector into the type glm::u32vec2.
operator std::array<unsigned int, 2U>	Converts the vector to an instance of std::array.
operator std::vector<unsigned int>	Converts the vector into an instance of type std::vector.

Using Declarations

Name
Vector2u

Protected Type Aliases

Name
array_type

Protected Data Members

Name
m_elements