XMFLOAT3 structure (directxmath.h)

Describes a 3D vector consisting of three single-precision floating-point values.

For a list of additional functionality such as constructors and operators that are available using XMFLOAT3 when you are programming in C++, see XMFLOAT3 Extensions.

Note  See DirectXMath Library Type Equivalences for information about equivalent D3DDECLTYPE, D3DFORMAT, and DXGI_FORMAT objects.

 

Syntax

struct XMFLOAT3 {
  float      x;
  float      y;
  float      z;
  void       XMFLOAT3();
  void       XMFLOAT3(
    const XMFLOAT3 & unnamedParam1
  );
  XMFLOAT3 & operator=(
    const XMFLOAT3 & unnamedParam1
  );
  void       XMFLOAT3(
    XMFLOAT3 && unnamedParam1
  );
  XMFLOAT3 & operator=(
    XMFLOAT3 && unnamedParam1
  );
  void       XMFLOAT3(
    float _x,
    float _y,
    float _z
  ) noexcept;
  void       XMFLOAT3(
    const float *pArray
  ) noexcept;
};

Members

x

float value describing the x-coordinate of the vector.

y

float value describing the y-coordinate of the vector.

z

float value describing the z-coordinate of the vector.

void XMFLOAT3()

Default constructor for XMFLOAT3.

Default constructor for XMFLOAT3.

Note  This constructor is only available under C++.

 

void XMFLOAT3( const XMFLOAT3 & unnamedParam1)

A constructor for XMFLOAT3.

A constructor for XMFLOAT3.

Note  This constructor is only available under C++.

XMFLOAT3 & operator=( const XMFLOAT3 & unnamedParam1)

Assigns the vector component data from one instance of XMFLOAT3 to the current instance of XMFLOAT3.

This operator assigns the vector component data from one instance of XMFLOAT3 to the current instance of XMFLOAT3.

Note  This operator is only available under C++.

void XMFLOAT3( XMFLOAT3 && unnamedParam1)

A constructor for XMFLOAT3.

A constructor for XMFLOAT3.

Note  This constructor is only available under C++.

XMFLOAT3 & operator=( XMFLOAT3 && unnamedParam1)

void XMFLOAT3( float _x, float _y, float _z) noexcept

Initializes a new instance of XMFLOAT3 from three float arguments.

This constructor initializes a new instance of XMFLOAT3 from a three float arguments.

Note  This constructor is only available under C++.

 

void XMFLOAT3( const float *pArray) noexcept

A constructor for XMFLOAT3.

A constructor for XMFLOAT3.

Note  This constructor is only available under C++.

Remarks

XMFLOAT3 can be loaded into instances of XMVECTOR by using XMLoadFloat3.

Instances of XMVECTOR can be stored into an instance of XMFLOAT3 with XMStoreFloat3.

Namespace: Use DirectX

Platform Requirements

Microsoft Visual Studio 2010 or Microsoft Visual Studio 2012 with the Windows SDK for Windows 8. Supported for Win32 desktop apps, Windows Store apps, and Windows Phone 8 apps.

Requirements

Requirement	Value
Header	directxmath.h

See also

DirectXMath Library Structures

XMFLOAT3 Extensions