DeviceImageInformation Structure (Microsoft.DirectX.DirectInput)

Article
06/29/2006

Carries information required to display a device image or an overlay image with a callout. This structure is passed to the Inputdevice9Getimageinfo method as an array within a Dideviceimageinfoheader structure.

Definition

Visual Basic Public Structure DeviceImageInformation

C# public struct DeviceImageInformation

C++ public value class DeviceImageInformation sealed

JScript In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object.

Fields

Field Description

CalloutLine Array of POINT structures that specify coordinates of the points describing a callout line. A callout line connects a device control to a caption for the game action. Each line can have from one to four segments. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

CalloutRectangle RECT structure that describes the rectangle in which the game action string is displayed. If the string cannot fit within the rectangle, the application is responsible for handling clipping. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

Overlay Rectangle, using coordinates relative to the top-left pixel of the device configuration image, in which the overlay image should be painted. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

Methods

Method Description

DeviceImageInformation Initializes a new instance of the object.

ToString Obtains a string representation of the current instance.

Properties

Property Description

Flags Flag that describes the intended use of the image.

ImagePath Fully qualified path to the file that contains an image of the device. The file format is given in DwFlags. If no image is available for the device, this member will be set to NULL. If so, the application is responsible for enumerating controls on the device and displaying a default listing of actions to device controls (similar to the method used by most applications before Microsoft® DirectX® 8.0).

ObjectId Control identifier, as a combination of DIDFT_* flags and an instance value, to which an overlay image corresponds for this device. Applications use the DIDFT_GETINSTANCE and DIDFT_GETTYPE macros to decode this value to its constituent parts. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

TextAlign DWORD value that specifies the alignment of the text in the rectangle described by the RcCalloutRect member. Must be one horizontal alignment flag combined with one vertical alignment flag. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

ViewId For device view images (DIDIFT_CONFIGURATION), this is the identifier of the device view.

Field	Description
CalloutLine	Array of POINT structures that specify coordinates of the points describing a callout line. A callout line connects a device control to a caption for the game action. Each line can have from one to four segments. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.
CalloutRectangle	RECT structure that describes the rectangle in which the game action string is displayed. If the string cannot fit within the rectangle, the application is responsible for handling clipping. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.
Overlay	Rectangle, using coordinates relative to the top-left pixel of the device configuration image, in which the overlay image should be painted. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.

Method	Description
DeviceImageInformation	Initializes a new instance of the object.
ToString	Obtains a string representation of the current instance.

Property	Description
Flags	Flag that describes the intended use of the image.
ImagePath	Fully qualified path to the file that contains an image of the device. The file format is given in DwFlags. If no image is available for the device, this member will be set to NULL. If so, the application is responsible for enumerating controls on the device and displaying a default listing of actions to device controls (similar to the method used by most applications before Microsoft® DirectX® 8.0).
ObjectId	Control identifier, as a combination of DIDFT_* flags and an instance value, to which an overlay image corresponds for this device. Applications use the DIDFT_GETINSTANCE and DIDFT_GETTYPE macros to decode this value to its constituent parts. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.
TextAlign	DWORD value that specifies the alignment of the text in the rectangle described by the RcCalloutRect member. Must be one horizontal alignment flag combined with one vertical alignment flag. This member is valid only if the DIDIFT_OVERLAY flag is present in DwFlags.
ViewId	For device view images (DIDIFT_CONFIGURATION), this is the identifier of the device view.

Structure Information

Namespace Microsoft.DirectX.DirectInput

Assembly Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)

Strong Name Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	Public Structure DeviceImageInformation
C#	public struct DeviceImageInformation
C++	public value class DeviceImageInformation sealed
JScript	In JScript, you can use structures, but you cannot define your own.

Namespace	Microsoft.DirectX.DirectInput
Assembly	Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)
Strong Name	Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

DeviceImageInformation Structure (Microsoft.DirectX.DirectInput)

Additional resources