Edit

Share via

XMUSHORT2 structure (directxpackedvector.h)

  • Article

Describes a 2D vector consisting of 16-bit unsigned integer components.

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

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

Syntax

struct XMUSHORT2 {
  union {
    struct {
      uint16_t x;
      uint16_t y;
    };
    uint32_t v;
  };
  void        XMUSHORT2();
  void        XMUSHORT2(
    const XMUSHORT2 & unnamedParam1
  );
  XMUSHORT2 & operator=(
    const XMUSHORT2 & unnamedParam1
  );
  void        XMUSHORT2(
    XMUSHORT2 && unnamedParam1
  );
  XMUSHORT2 & operator=(
    XMUSHORT2 && unnamedParam1
  );
  void        XMUSHORT2(
    uint32_t Packed
  ) noexcept;
  void        XMUSHORT2(
    uint16_t _x,
    uint16_t _y
  ) noexcept;
  void        XMUSHORT2(
    const uint16_t *pArray
  ) noexcept;
  void        XMUSHORT2(
    float _x,
    float _y
  ) noexcept;
  void        XMUSHORT2(
    const float *pArray
  ) noexcept;
  XMUSHORT2 & operator=(
    uint32_t Packed
  ) noexcept;
};

Members

x

Unsigned integer in the range [0, 65535] describing the x-coordinate of the vector.

y

Unsigned integer in the range [0, 65535] describing the y-coordinate of the vector.

v

void XMUSHORT2()

Default constructor for XMUSHORT2.

Default constructor for XMUSHORT2.

Note  This constructor is only available under C++.
 

void XMUSHORT2( const XMUSHORT2 & unnamedParam1)

A constructor for XMUSHORT2.

A constructor for XMUSHORT2.

Note  This constructor is only available under C++.

XMUSHORT2 & operator=( const XMUSHORT2 & unnamedParam1)

void XMUSHORT2( XMUSHORT2 && unnamedParam1)

A constructor for XMUSHORT2.

A constructor for XMUSHORT2.

Note  This constructor is only available under C++.

XMUSHORT2 & operator=( XMUSHORT2 && unnamedParam1)

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

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

Note  This operator is only available under C++.

void XMUSHORT2( uint32_t Packed) noexcept

A constructor for XMUSHORT2.

A constructor for XMUSHORT2.

Note  This constructor is only available under C++.

void XMUSHORT2( uint16_t _x, uint16_t _y) noexcept

Initializes a new instance of XMUSHORT2 from two uint16_t arguments.

This constructor initializes a new instance of XMUSHORT2 from two uint16_t arguments.

Note  This constructor is only available under C++.
 

void XMUSHORT2( const uint16_t *pArray) noexcept

Initializes a new instance of XMUSHORT2 from an array of uint16_t arguments.

This constructor initializes a new instance of XMUSHORT2 from an array of uint16_t arguments.

Note  This constructor is only available under C++.

void XMUSHORT2( float _x, float _y) noexcept

Initializes a new instance of XMUSHORT2 from two float arguments.

This constructor initializes a new instance of XMUSHORT2 from two float arguments.

Note  This constructor is only available under C++.
 

void XMUSHORT2( const float *pArray) noexcept

Initializes a new instance of XMUSHORT2 from a two element float array argument.

This constructor initializes a new instance of XMUSHORT2 from a from a two element float array argument.

Note  This constructor is only available under C++.

XMUSHORT2 & operator=( uint32_t Packed) noexcept

Remarks

XMUSHORT2 can be loaded into instances of XMVECTOR by using XMLoadUShort2.

Instances of XMVECTOR can be stored into an instance of XMUSHORT2 with XMStoreUShort2.

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

XMUSHORT2 Extensions