The Bitmap object describes the drawable pixel region presented by the display. It stores the width, height, colour format, palette and related bitmap state. Display fields mirror the most common bitmap dimensions, so callers rarely need to access the bitmap directly for simple sizing operations.

The Bitmap⇒Width and Bitmap⇒Height can be larger than the visible display area, but never smaller.

This field stores the horizontal offset of the Bitmap relative to the visible display viewport. It is used by drivers that support a bitmap larger than the visible display area.

This field stores the vertical offset of the Bitmap relative to the visible display viewport. It is used by drivers that support a bitmap larger than the visible display area.

If the display is hosted in a client window, the BottomMargin indicates the number of pixels between the client area and the bottom window edge.

This string describes the graphic card's chipset, if known.

This string describes the display device that is connected to the user's graphics card.

This string names the manufacturer of the user's display device.

This field reports the display driver type, such as native, X11, Windows GDI or OpenGL ES.

Display flags configure hosted-window behaviour, buffering, visibility, controller grabbing and driver-reported capabilities. After initialisation, only a limited subset can be changed and support for changing window style is platform dependent.

The gamma settings for the display are stored in this field. The settings are stored in an array of 3 floating point values that represent the red, green and blue colour components. The default gamma value for each component is 1.0.

To modify the display gamma values, please refer to the SetGamma() and SetGammaLinear() methods.

Reading the HDensity field will return the horizontal pixel density for the display (pixels per inch). If the physical size of the display is unknown, a default value based on the platform is returned. For standard desktop systems this will usually be 96.

A custom density value can be enforced by setting the /interface/@dpi value in the loaded style, or by setting HDensity.

Reading this field always succeeds.

This field defines the visible display viewport height. If the height exceeds allowable limits, it is restricted to a value that the display driver can handle.

If the display is hosted, the height reflects the internal height of the host window. On some hosted systems, the true height of the window can be calculated by reading the TopMargin and BottomMargin fields.

On drivers that support a drawable area larger than the visible viewport, InsideHeight reflects the internal bitmap height in pixels. If this feature is not in use, InsideHeight is equal to Height.

On drivers that support a drawable area larger than the visible viewport, InsideWidth reflects the internal bitmap width in pixels. If this feature is not in use, InsideWidth is equal to Width.

If the display is hosted in a client window, the LeftMargin indicates the number of pixels between the client area and the left window edge.

The string in this field returns the name of the manufacturer that created the user's graphics card. If this information is not detectable, a NULL pointer is returned.

If the display output device supports variable refresh rates, this field will refer to the maximum horizontal scan rate supported by the device. If variable refresh rates are not supported, this field is set to zero.

If the display output device supports variable refresh rates, this field will refer to the maximum vertical scan rate supported by the device. If variable refresh rates are not supported, this field is set to zero.

If the display output device supports variable refresh rates, this field will refer to the minimum horizontal scan rate supported by the device. If variable refresh rates are not supported, this field is set to zero.

If the display output device supports variable refresh rates, this field will refer to the minimum vertical scan rate supported by the device. If variable refresh rates are not supported, this field is set to zero.

This field determines the translucency level applied to a hosted display window, expressed as a normalised value. The default setting is 1, which makes the display fully opaque. Lower values make the window more transparent where the host platform supports translucent windows.

The PopOver field can be used when a display is hosted as a window. Setting the PopOver field to refer to the object ID of another display will ensure that the host window is always in front of the other display's window (assuming both windows are visible on the desktop).

The ERR::NoSupport error code is returned if the host does not support this functionality or if the display owns the output device.

When DPMS is supported and Disable() is called, this field identifies the requested power-management mode.

DPMS is normally user-configurable, so applications should avoid changing PowerMode without user intent.

This field reflects the refresh rate of the currently active full-screen display mode where the driver can report it. Hosted display drivers may leave this value unset or set it to a sentinel value.

Set this field to receive display resize feedback from hosted-window events and display-managed coordinate repairs. The callback receives the display object ID, X, Y, Width and Height values.

Reading the VDensity field will return the vertical pixel density for the display (pixels per inch). If the physical size of the display is unknown, a default value based on the platform is returned. For standard desktop systems this will usually be 96.

A custom density value can be enforced by setting the /interface/@dpi value in the loaded style, or by setting VDensity.

Reading this field always succeeds.

This field defines the visible display viewport width. If the width exceeds allowable limits, it is restricted to a value that the display driver can handle.

If the display is hosted, the width reflects the internal width of the host window. On some hosted systems, the true width of the window can be calculated by reading the LeftMargin and RightMargin fields.

This field refers to the platform window handle owned or used by the display. It is relevant only on hosted display backends such as X11 and Microsoft Windows.

Set WindowHandle before initialisation to bind the Display object to an existing host window. In that case the display sets SCR::CUSTOM_WINDOW and will not destroy the host window as its own resource.

The X field defines the horizontal coordinate of the display. On native full-screen drivers this is a hardware offset and should normally remain zero unless the output device requires adjustment.

On hosted displays, prior to initialisation the coordinate will reflect the position of the display window when it is created. After initialisation, the coordinate is altered to reflect the absolute position of the client area of the display window. The LeftMargin can be used to determine the actual position of the host window.

To adjust the position of the display, use the MoveToPoint() action rather than setting this field directly.

The Y field defines the vertical coordinate of the display. On native full-screen drivers this is a hardware offset and should normally remain zero unless the output device requires adjustment.

On hosted displays, prior to initialisation the coordinate will reflect the position of the display window when it is created. After initialisation, the coordinate is altered to reflect the absolute position of the client area of the display window. The TopMargin can be used to determine the actual position of the host window.

To adjust the position of the display, use the MoveToPoint() action rather than setting this field directly.