XMBYTE4 structure (directxpackedvector.h)

  • Article

A 4D vector where each component is a signed integer, 8-bits (1 byte) in length.

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

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

Syntax

struct XMBYTE4 {
  union {
    struct {
      int8_t x;
      int8_t y;
      int8_t z;
      int8_t w;
    };
    uint32_t v;
  };
  void      XMBYTE4();
  void      XMBYTE4(
    const XMBYTE4 & unnamedParam1
  );
  XMBYTE4 & operator=(
    const XMBYTE4 & unnamedParam1
  );
  void      XMBYTE4(
    XMBYTE4 && unnamedParam1
  );
  XMBYTE4 & operator=(
    XMBYTE4 && unnamedParam1
  );
  void      XMBYTE4(
    int8_t _x,
    int8_t _y,
    int8_t _z,
    int8_t _w
  ) noexcept;
  void      XMBYTE4(
    uint32_t Packed
  ) noexcept;
  void      XMBYTE4(
    const int8_t *pArray
  ) noexcept;
  void      XMBYTE4(
    float _x,
    float _y,
    float _z,
    float _w
  ) noexcept;
  void      XMBYTE4(
    const float *pArray
  ) noexcept;
  XMBYTE4 & operator=(
    uint32_t Packed
  ) noexcept;
};

Members

x

Signed 8-bit integer value in the range [-127, 127] describing the x-coordinate of the vector.

y

Signed 8-bit integer value in the range [-127, 127] describing the y-coordinate of the vector.

z

Signed 8-bit integer value in the range [-127, 127] describing the z-coordinate of the vector.

w

Signed 8-bit integer value in the range [-127, 127] describing the w-coordinate of the vector.

v

Unsigned 32-bit integer representing the 4D vector.

void XMBYTE4()

Default constructor for XMBYTE4.

Default constructor for XMBYTE4.

Note  This constructor is only available under C++.
 

void XMBYTE4( const XMBYTE4 & unnamedParam1)

A constructor for XMBYTE4.

A constructor for XMBYTE4.

Note  This constructor is only available under C++.

XMBYTE4 & operator=( const XMBYTE4 & unnamedParam1)

void XMBYTE4( XMBYTE4 && unnamedParam1)

a constructor for XMBYTE4.

A constructor for XMBYTE4.

Note  This constructor is only available under C++.

XMBYTE4 & operator=( XMBYTE4 && unnamedParam1)

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

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

Note  This operator is only available under C++.

void XMBYTE4( int8_t _x, int8_t _y, int8_t _z, int8_t _w) noexcept

Initializes a new instance of XMBYTE4 from four int8_t arguments.

This constructor initializes a new instance of XMBYTE4 from four int8_t arguments.

Note  This constructor is only available under C++.
 

void XMBYTE4( uint32_t Packed) noexcept

Initializes a new instance of XMBYTE4 from a uint32_t variable containing component data in a packed format.

This constructor initializes a new instance of XMBYTE4 from a uint32_t variable containing component data in a packed format.

Note  This constructor is only available under C++.
 

void XMBYTE4( const int8_t *pArray) noexcept

Initializes a new instance of XMBYTE4 from a four element int8_t array argument.

This constructor initializes a new instance of XMBYTE4 from a from a four element int8_t array argument.

Note  This constructor is only available under C++.

void XMBYTE4( float _x, float _y, float _z, float _w) noexcept

Initializes a new instance of XMBYTE4 from four float arguments.

This constructor initializes a new instance of XMBYTE4 from four float arguments.

Note  This constructor is only available under C++.
 

void XMBYTE4( const float *pArray) noexcept

Initializes a new instance of XMBYTE4 from a four element float array argument.

This constructor initializes a new instance of XMBYTE4 from a four element float array argument.

Note  This constructor is only available under C++.

XMBYTE4 & operator=( uint32_t Packed) noexcept

Remarks

XMBYTE4 can be loaded into instances of XMVECTOR by using XMLoadByte4.

Instances of XMVECTOR can be stored into an instance of XMBYTE4 with XMStoreByte4.

Namespace: Use DirectX::PackedVector

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 directxpackedvector.h

See also

DirectXMath Library Structures

XMBYTE4 Extensions