DIDEVICEIMAGEINFO

Carries information required to display a device image, or an overlay image with a callout. This type is passed to the DirectInputDevice8.GetImageInfo method as an array within a DIDEVICEIMAGEINFOHEADER type.

Type DIDEVICEIMAGEINFO 
    CalloutLine(0 To 4) As POINT
    CalloutRect As RECT
    flags As Long
    ImagePath As String
    ObjId As Long
    ViewID As Long
    OverlayRect As RECT
    TextAlign As Long
    ValidPts As Long
End Type

Members

CalloutLine

Array of types 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 one to four segments. This member is valid only if the DIDIFT_OVERLAY flag is present in flags.

CalloutRect

Type that specifies coordinates of the rectangle in which the game action string is displayed. The application handles clipping. This member is valid only if the DIDIFT_OVERLAY flag is present in flags.

flags

Flag that describes the intended use of the image. This member can be one of the following values from the CONST_DIDIFTFLAGS enumeration.

DIDIFT_CONFIGURATION

The file is used to display the current configuration of actions on the device. Overlay image coordinates are relative to the upper left corner of the configuration image.

DIDIFT_OVERLAY

The file (if provided) is an overlay for a particular control on the configuration image. The ViewID, OverlayRect, ObjID, CalloutLine, CalloutRect, and TextAlign members are valid and contain data used to display the overlay and callout information for a single control on the device. If no file is provided (null path string), all other pertinent members are relevant except rdOverlay.

ImagePath

Fully qualified path to the file that contains an image of the device.

ObjId

Control identifier, combining object type flags and an instance value, to which an overlay image corresponds for this device. For more information on this identifier, see DirectInputDeviceObjectInstance.GetType. This member is valid only if the DIDIFT_OVERLAY flag is present in flags.

OverlayOffset

Offset of the device configuration image over which this overlay is to be displayed. This member is valid only if the DIDIFT_OVERLAY flag is present in flags.

OverlayRect

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 flags.

TextAlign

Value that specifies the alignment of the text in the rectangle described by the CalloutRect member. Must be one horizontal alignment flag combined with one vertical alignment flag from the CONST_DIDALFLAGS enumeration.

The following horizontal alignment flags are defined.

DIDAL_LEFTALIGNED

Text is aligned on the left border.

DIDAL_CENTERED

Text is horizontally centered.

DIDAL_RIGHTALIGNED

Text is aligned on the right border.

The following vertical alignment flags are defined.

DIDAL_MIDDLE

The text is vertically centered.

DIDAL_TOPALIGNED

The text is aligned on the top border.

DIDAL_BOTTOMALIGNED

The text is aligned on the bottom border.

This member is valid only if the DIDIFT_OVERLAY flag is present in flags.

ValidPts

Number of points in the CalloutLine array.

ViewID

For device view images (DIDIFT_CONFIGURATION), this is the ID of the device view. For device control overlays (DIDIFT_OVERLAY), this value refers to the device view (by ID) over which an image and callout information should be displayed.