DXGKARG_SETPOINTERSHAPE structure (d3dkmddi.h)

The DXGKARG_SETPOINTERSHAPE structure describes the appearance of the mouse pointer and the location that it should be displayed in.

Syntax

typedef struct _DXGKARG_SETPOINTERSHAPE {
  [in] DXGK_POINTERFLAGS              Flags;
  [in] UINT                           Width;
  [in] UINT                           Height;
  [in] UINT                           Pitch;
  [in] D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId;
  [in] const VOID                     *pPixels;
  [in] UINT                           XHot;
  [in] UINT                           YHot;
} DXGKARG_SETPOINTERSHAPE;

Members

[in] Flags

A DXGK_POINTERFLAGS structure that identifies, in bit-field flags, how to display the mouse pointer.

[in] Width

The width of the mouse pointer, in pixels.

[in] Height

The height of the mouse pointer, in scan lines.

[in] Pitch

The width of the mouse pointer, in bytes.

[in] VidPnSourceId

The zero-based identification number of the video present source in a path of a video present network (VidPN) topology that the mouse pointer is located in.

[in] pPixels

A pointer to the start of the following bitmap depending on the bit-field flag that is set in the Flags member:

Bit-field flag	Bitmap
Monochrome	For monochrome mouse pointers: A monochrome bitmap whose size is specified by Width and Height in a 1 bits per pixel (bpp) DIB format AND mask that is followed by another 1 bpp DIB format XOR mask of the same size.
Color	For color mouse pointers: A color bitmap whose size is specified by Width and Height in a 32 bpp ARGB device independent bitmap (DIB) format.
MaskedColor	For masked color mouse pointers: A 32-bpp ARGB format bitmap with the mask value in the alpha bits. The only allowed mask values are 0 and 0xFF. When the mask value is 0, the RGB value should replace the screen pixel. When the mask value is 0xFF, an XOR operation is performed on the RGB value and the screen pixel; the result should replace the screen pixel.

[in] XHot

The column, in pixels, that the mouse pointer is located on from the top left of the bitmap that pPixels points to.

[in] YHot

The row, in pixels, that the mouse pointer is located on from the top left of the bitmap that pPixels points to.

Remarks

The XHot and YHot members are used by display miniport drivers that are not associated with hardware, and these members can be ignored by drivers that control hardware.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Header	d3dkmddi.h (include D3dkmddi.h)

See also

DXGK_POINTERFLAGS

DxgkDdiSetPointerShape