Unit GraphicsConsole
Return to Unit Reference
Contents
Description
Ultibo Graphics Console Interface unit
The Graphics console unit provides access to the underlying framebuffer device as a pixel interface that allows putting blocks (or rectangles) of pixel data on to the screen or getting rectangles of pixel data from the screen. Functions are also included to copy a rectangle from one part of the screen to another and to put text (with a specified font) on to the screen.
Most image formats either consist of, or can be decoded to, a block of data that is a number of horizontal rows each with a number of pixels (columns) with each pixel containing color information in a certain bit size (8/16/24/32) and format (RGB/BGR/RGBA etc).
If the data exists in memory as a single contiguous block with each row following directly after the previous row then that can be passed directly to the functions in this unit (eg GraphicsWindowDrawImage) to be drawn on the screen.
Many graphics libraries do image manipulation, rendering and compositing to a memory buffer in a form that is compatible with the functions in this unit so a complex image can be constructed in memory and then transferred to the screen in a single operation. This is sometimes referred to as a bit block transfer or BitBlt and is a very standard technique for rendering both text and images to a framebuffer device.
This unit extends the console unit by creating a new type of console window (WINDOW_MODE_GRAPHICS) and therefore allows both text console windows and graphics console windows to co-exist on the screen at once.
The functions in this unit cannot be used to draw on a text console window (WINDOW_MODE_TEXT) and vice versa the functions in the console unit cannot be used to draw on a graphics console window.
Like the console unit, the graphics console supports setting a viewport for a specified window to allow masking the area to be written to. However the graphics console does not support tracking a cursor X and Y position. Setting a window as the default is also not supported since that functionality is purely intended to support the RTL functions for text output.
Graphics windows can only be created on console devices which have a mode of CONSOLE_MODE_PIXEL.
Notes: Unlike the Console unit, Graphics console coordinates are always based on pixels not characters. Graphics console coordinates begin at 0,0 and extend to Width - 1, Height - 1. Graphics Window coordinates X,Y are always based on pixels, beginning at 0,0 and extending to Cols - 1, Rows - 1.
Constants
None defined
Type definitions
Graphics window enumeration callback
TGraphicsWindowEnumerate = TConsoleWindowEnumerate;
|
Graphics window types
PGraphicsWindow = ^TGraphicsWindow;
TGraphicsWindow = TConsoleWindow;
Class definitions
Graphics console specific classes
TGraphicImage = class(TObject)
|
Public variables
None defined
Function declarations
Initialization functions
procedure GraphicsConsoleInit;
Note | Called only during system startup |
---|
Graphics console functions
function GraphicsWindowCreate(Console:PConsoleDevice; Position:LongWord):TWindowHandle;
Console | The console device to create the new window on |
---|---|
Position | The console position to create the new window at (eg CONSOLE_POSITION_FULL) |
Return | Handle to new Graphics window or INVALID_HANDLE_VALUE if the window could not be created |
function GraphicsWindowCreateEx(Console:PConsoleDevice; Font:TFontHandle; Size,State,Mode,Position:LongWord):TWindowHandle;
Console | The console device to create the new window on |
---|---|
Font | The handle of the default font for the new console window |
Size | The size in bytes to allocate for the new window entry (Defaults to SizeOf(TGraphicsWindow)) |
State | The state of the new console window (WINDOW_STATE_VISIBLE or WINDOW_STATE_INVISIBLE) |
Mode | The mode of the new console window (Normally WINDOW_MODE_GRAPHICS) |
Position | The console position to create the new window at (eg CONSOLE_POSITION_FULL) |
Return | Handle to new Graphics window or INVALID_HANDLE_VALUE if the window could not be created |
function GraphicsWindowDestroy(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to destroy |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowShow(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to show |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowHide(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to hide |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowActivate(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to activate |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowDeactivate(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to deactivate |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | On success there will be no active window set |
function GraphicsWindowNext(Console:PConsoleDevice; Visible:Boolean):TWindowHandle; inline;
Console | The console device to change the active window on |
---|---|
Visible | If true only return windows that are visible |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowPrevious(Console:PConsoleDevice; Visible:Boolean):TWindowHandle; inline;
Console | The console device to change the active window on |
---|---|
Visible | If true only return windows that are visible |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowAt(Console:PConsoleDevice; X,Y:LongWord; Visible:Boolean):TWindowHandle; inline;
Console | The console device to find the window on |
---|---|
X | The X coordinate to find the window for |
Y | The Y coordinate to find the window for |
Visible | If true only return windows that are visible |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowFind(Console:PConsoleDevice; Position:LongWord):TWindowHandle; inline;
Console | The console device to find the window on |
---|---|
Position | The window position to find (eg CONSOLE_POSITION_FULL) |
Return | The handle of the existing window or INVALID_HANDLE_VALUE if not found |
function GraphicsWindowEnumerate(Console:PConsoleDevice; Callback:TGraphicsWindowEnumerate; Data:Pointer):LongWord; inline;
Console | The console device to enumerate windows for |
---|---|
Callback | The function to call for each window enumerated |
Data | A pointer to private data to be passed to the callback (Optional) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCheckFlag(Handle:TWindowHandle; Flag:LongWord):Boolean; inline;
Handle | The handle of the window to check |
---|---|
Flag | The window flag to check for (eg WINDOW_FLAG_LINE_WRAP) |
Return | True if the flag is set, False if not set. |
function GraphicsWindowUpdateFlag(Handle:TWindowHandle; Flag:LongWord; Clear:Boolean):LongWord; inline;
Handle | The handle of the window to set or clear the flag on |
---|---|
Flag | The window flag to set or clear (eg WINDOW_FLAG_LINE_WRAP) |
Clear | If true clear the flag, else set it. |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetMode(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to get the mode for |
---|---|
Return | The window mode (eg WINDOW_MODE_GRAPHICS) |
function GraphicsWindowGetState(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to get the state for |
---|---|
Return | The window state (eg WINDOW_STATE_INVISIBLE) |
function GraphicsWindowGetPosition(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to get the position for |
---|---|
Return | The window position (eg CONSOLE_POSITION_FULL) |
function GraphicsWindowSetPosition(Handle:TWindowHandle; Position:LongWord):LongWord;
Handle | The handle of the window to set the position for |
---|---|
Position | The new window position to set |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | The function will return ERROR_INVALID_PARAMETER if another window exists at the position |
function GraphicsWindowGetProperties(Handle:TWindowHandle; Properties:PWindowProperties):LongWord; inline;
Handle | The handle of the window to get the properties from |
---|---|
Properties | Pointer to a TWindowProperties structure to fill in |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetMinX(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get MinX for |
---|---|
Return | The minimum X value for the current window viewport |
Note | For Graphics Console functions, X is based on screen pixels not characters. |
function GraphicsWindowGetMinY(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get MinY for |
---|---|
Return | The minimum Y value for the current window viewport |
Note | For Graphics Console functions, Y is based on screen pixels not characters. |
function GraphicsWindowGetMaxX(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get MaxX for |
---|---|
Return | The maximum X value for the current window viewport |
Note | For Graphics Console functions, X is based on screen pixels not characters. |
function GraphicsWindowGetMaxY(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get MaxY for |
---|---|
Return | The maximum Y value for the current window viewport |
Note | For Graphics Console functions, Y is based on screen pixels not characters. |
function GraphicsWindowGetRect(Handle:TWindowHandle):TConsoleRect; inline;
Handle | The handle of the window to get the rectangle for |
---|---|
Return | The rectangle of the current window viewport |
Note | For Graphics Console functions, Rect is based on screen pixels not characters. |
function GraphicsWindowSetRect(Handle:TWindowHandle; const ARect:TConsoleRect):LongWord; inline;
Handle | The handle of the window to set the rectangle for |
---|---|
Rect | The rectangle to set for the window viewport |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Rect is based on screen pixels not characters. |
function GraphicsWindowResetRect(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to reset the viewport for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetViewport(Handle:TWindowHandle; var X1,Y1,X2,Y2:LongWord):LongWord;
Handle | The handle of the window to get the viewport for |
---|---|
X1 | The left edge of the current viewport |
Y1 | The top edge of the current viewport |
X2 | The right edge of the current viewport |
Y2 | The bottom edge of the current viewport |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowSetViewport(Handle:TWindowHandle; X1,Y1,X2,Y2:LongWord):LongWord;
Handle | The handle of the window to get the viewport for |
---|---|
X1 | The left edge of the window viewport |
Y1 | The top edge of the window viewport |
X2 | The right edge of the window viewport |
Y2 | The bottom edge of the window viewport |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowResetViewport(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to reset the viewport for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetCols(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get columns for |
---|---|
Return | The columns value for the current window viewport |
Note | For Graphics Console functions, Columns is based on screen pixels not characters. |
function GraphicsWindowGetRows(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get rows for |
---|---|
Return | The rows value for the current window viewport |
Note | For Graphics Console functions, Rows is based on screen pixels not characters. |
function GraphicsWindowGetWidth(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get the width for |
---|---|
Return | The absolute width of the window |
Note | For Graphics Console functions, Width is based on screen pixels not characters. |
function GraphicsWindowGetHeight(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get the height for |
---|---|
Return | The absolute height of the window |
Note | For Graphics Console functions, Height is based on screen pixels not characters. |
function GraphicsWindowGetFormat(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get the format for |
---|---|
Return | The color format of the window (eg COLOR_FORMAT_ARGB32) |
function GraphicsWindowGetForecolor(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get the foreground color for |
---|---|
Return | The foreground color of the window (eg COLOR_WHITE) |
function GraphicsWindowSetForecolor(Handle:TWindowHandle; Color:LongWord):LongWord;
Handle | The handle of the window to set the foreground color for |
---|---|
Color | The foreground color to set (eg COLOR_WHITE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetBackcolor(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to get the background color for |
---|---|
Return | The background color of the window (eg COLOR_BLACK) |
function GraphicsWindowSetBackcolor(Handle:TWindowHandle; Color:LongWord):LongWord;
Handle | The handle of the window to set the background color for |
---|---|
Color | The background color to set (eg COLOR_BLACK) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetFont(Handle:TWindowHandle):TFontHandle;
Handle | The handle of the window to get the default font for |
---|---|
Return | The font handle of the default font or INVALID_HANDLE_VALUE on error |
function GraphicsWindowSetFont(Handle:TWindowHandle; Font:TFontHandle):LongWord;
Handle | The handle of the window to set the default font for |
---|---|
Font | The font handle of the default font to set |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetCursorXY(Handle:TWindowHandle; var X,Y:LongWord):LongWord; inline;
Handle | The handle of the window to get cursor X and Y for |
---|---|
X | The returned cursor X value |
Y | The returned cursor Y value |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, cursor X and Y are based on screen pixels not characters. |
function GraphicsWindowSetCursorXY(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Handle | The handle of the window to set cursor X and Y for |
---|---|
X | The new cursor X value |
Y | The new cursor Y value |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, cursor X and Y are based on screen pixels not characters. |
function GraphicsWindowGetCursorMode(Handle:TWindowHandle):TCursorMode; inline;
Handle | The handle of the window to get the mode for |
---|---|
Return | The current cursor mode (eg CURSOR_MODE_INSERT) |
function GraphicsWindowSetCursorMode(Handle:TWindowHandle; CursorMode:TCursorMode):LongWord; inline;
Handle | The handle of the window to set the mode for |
---|---|
CursorMode | The cursor mode to set (eg CURSOR_MODE_INSERT) |
Return | ERROR_SUCCESS if completed or another error code on failure} |
function GraphicsWindowGetCursorBlink(Handle:TWindowHandle):Boolean; inline;
Handle | The handle of the window to get blink state for |
---|---|
Return | True if blink is enabled, False if not or on error. |
function GraphicsWindowSetCursorBlink(Handle:TWindowHandle; CursorBlink:Boolean):LongWord; inline;
Handle | The handle of the window to set the blink state for |
---|---|
CursorBlink | True to enable blink, False to disable |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetCursorState(Handle:TWindowHandle):TCursorState; inline;
Handle | The handle of the window to get the state for |
---|---|
Return | The current cursor state (eg CURSOR_STATE_ON) |
function GraphicsWindowSetCursorState(Handle:TWindowHandle; CursorState:TCursorState):LongWord; inline;
Handle | The handle of the window to set the state for |
---|---|
CursorState | The cursor state to set (eg CURSOR_STATE_ON) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowGetCursorShape(Handle:TWindowHandle):TCursorShape; inline;
Handle | The handle of the window to get the shape for |
---|---|
Return | The current cursor shape (eg CURSORLINE) |
function GraphicsWindowSetCursorShape(Handle:TWindowHandle; CursorShape:TCursorShape):LongWord; inline;
Handle | The handle of the window to set the shape for |
---|---|
CursorShape | The cursor shape to set (eg CURSORLINE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorOn(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to enable the cursor for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorOff(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to disable the cursor for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorLine(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to change the cursor for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorBar(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to change the cursor for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorBlock(Handle:TWindowHandle):LongWord; inline;
Handle | The handle of the window to change the cursor for |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowCursorMove(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Handle | The handle of the window to move the cursor for |
---|---|
X | The column to move the cursor to |
Y | The row to move the cursor to |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, X and Y are based on screen pixels not characters. |
function GraphicsWindowCursorBlink(Handle:TWindowHandle; Enabled:Boolean):LongWord; inline;
Handle | The handle of the window to set the blink state for |
---|---|
Enabled | True if the cursor is blinking, False if not |
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowClear(Handle:TWindowHandle):LongWord;
Handle | The handle of the window to clear |
---|---|
Return | ERROR_SUCCESS if completed or another error code on failure |
function GraphicsWindowClearEx(Handle:TWindowHandle; X1,Y1,X2,Y2,Color:LongWord):LongWord;
Handle | The handle of the window to clear |
---|---|
X1 | The left edge of the area to clear (relative to current viewport) |
Y1 | The top edge of the area to clear (relative to current viewport) |
X2 | The right edge of the area to clear (relative to current viewport) |
Y2 | The bottom edge of the area to clear (relative to current viewport) |
Color | The fill color for the area to clear (eg COLOR_WHITE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawBox(Handle:TWindowHandle; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X1 | The left edge of the box (relative to current viewport) |
Y1 | The top edge of the box (relative to current viewport) |
X2 | The right edge of the box (relative to current viewport) |
Y2 | The bottom edge of the box (relative to current viewport) |
Color | The color to draw with (eg COLOR_WHITE) |
Width | The width of the box outline |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawLine(Handle:TWindowHandle; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X1 | The left starting point of the line (relative to current viewport) |
Y1 | The top starting point of the line (relative to current viewport) |
X2 | The right ending point of the line (relative to current viewport) |
Y2 | The bottom ending point of the line (relative to current viewport) |
Color | The color to draw with (eg COLOR_WHITE) |
Width | The width of the line |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawBlock(Handle:TWindowHandle; X1,Y1,X2,Y2,Color:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X1 | The left edge of the block (relative to current viewport) |
Y1 | The top edge of the block (relative to current viewport) |
X2 | The right edge of the block (relative to current viewport) |
Y2 | The bottom edge of the block (relative to current viewport) |
Color | The color to draw with (eg COLOR_WHITE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawCircle(Handle:TWindowHandle; X,Y,Color,Width,Radius:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X | The left starting point of the circle (relative to current viewport) |
Y | The top starting point of the circle (relative to current viewport) |
Color | The color to draw with (eg COLOR_WHITE) |
Width | The width of the circle outline |
Radius | The radius of the circle |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawChar(Handle:TWindowHandle; Ch:Char; X,Y:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
Ch | The character to draw |
X | The left starting point of the character (relative to current viewport) |
Y | The top starting point of the character (relative to current viewport) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawCharEx(Handle:TWindowHandle; Font:TFontHandle; Ch:Char; X,Y,Forecolor,Backcolor:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
Font | The handle of the font to draw the character with |
Ch | The character to draw |
X | The left starting point of the character (relative to current viewport) |
Y | The top starting point of the character (relative to current viewport) |
Forecolor | The foreground color for the character (eg COLOR_WHITE) |
Backcolor | The background color for the character (eg COLOR_BLACK) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawText(Handle:TWindowHandle; const Text:String; X,Y:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
Text | The text to draw |
X | The left starting point of the text (relative to current viewport) |
Y | The top starting point of the text (relative to current viewport) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawTextEx(Handle:TWindowHandle; Font:TFontHandle; const Text:String; X,Y,Forecolor,Backcolor:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
Font | The handle of the font to draw the text with |
Text | The text to draw |
X | The left starting point of the text (relative to current viewport) |
Y | The top starting point of the text (relative to current viewport) |
Forecolor | The foreground color for the text (eg COLOR_WHITE) |
Backcolor | The background color for the text (eg COLOR_BLACK) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawPixel(Handle:TWindowHandle; X,Y,Color:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X | The column for the pixel (relative to current viewport) |
Y | The row for the pixel (relative to current viewport) |
Color | The color for the pixel (eg COLOR_WHITE) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowDrawImage(Handle:TWindowHandle; X,Y:LongWord; Image:Pointer; Width,Height,Format:LongWord):LongWord;
Handle | The handle of the window to draw on |
---|---|
X | The left starting point of the image (relative to current viewport) |
Y | The top starting point of the image (relative to current viewport) |
Image | Pointer to the image data in a contiguous block of pixel rows |
Width | The width in pixels of a row in the image data |
Height | The height in pixels of all rows in the image data |
Format | The color format of the image data (eg COLOR_FORMAT_ARGB32) Pass COLOR_FORMAT_UNKNOWN to use the window format |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowGetPixel(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Handle | The handle of the window to get from |
---|---|
X | The column of the pixel (relative to current viewport) |
Y | The row of the pixel (relative to current viewport) |
Return | The color of the pixel at X,Y (eg COLOR_WHITE) |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowGetImage(Handle:TWindowHandle; X,Y:LongWord; Image:Pointer; Width,Height,Format:LongWord):LongWord;
Handle | The handle of the window to get from |
---|---|
X | The left starting point of the image (relative to current viewport) |
Y | The top starting point of the image (relative to current viewport) |
Image | Pointer to a block of memory large enough to hold the image in a contiguous block of pixel rows |
Width | The width in pixels of a row of the image |
Height | The height in pixels of all rows of the image |
Format | The color format to store in the image data (eg COLOR_FORMAT_ARGB32) Pass COLOR_FORMAT_UNKNOWN to use the window format |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowCopyImage(Handle:TWindowHandle; const Source,Dest:TConsolePoint; Width,Height:LongWord):LongWord; inline;
Handle | The handle of the window to copy from and to |
---|---|
Source | The starting point (X,Y) to copy the image from |
Dest | The starting point (X,Y) to copy the image to |
Width | The width in pixels of each row of the image |
Height | The height in pixels of all rows of the image |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowMoveImage(Handle:TWindowHandle; const Source,Dest:TConsolePoint; Width,Height,Fillcolor:LongWord):LongWord;
Handle | The handle of the window to copy from and to |
---|---|
Source | The starting point (X,Y) to copy the image from |
Dest | The starting point (X,Y) to copy the image to |
Width | The width in pixels of each row of the image |
Height | The height in pixels of all rows of the image |
Fillcolor | The color to fill the area where the image was moved from (COLOR_NONE for no fill, same as copy) |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowImageSize(Handle:TWindowHandle; Width,Height,Format,Stride:LongWord):LongWord;
Handle | The handle of the window for the image |
---|---|
Width | The width of the image in pixels |
Height | The height of the image in pixels |
Format | The color format to use for the calculation (eg COLOR_FORMAT_ARGB32) Pass COLOR_FORMAT_UNKNOWN to use the window format |
Stride | The distance in bytes between each row of pixels (Optional) |
Return | The size in bytes for an image of the specified size and format or 0 on error |
function GraphicsWindowImageFromStream(Handle:TWindowHandle; X,Y:LongWord; Stream:TStream; Width,Height,Format,Stride:LongWord; Invert:Boolean):LongWord;
Handle | The handle of the window to draw on |
---|---|
X | The left starting point of the image (relative to current viewport) |
Y | The top starting point of the image (relative to current viewport) |
Stream | A stream containing the image data in a contiguous block of pixel rows |
Width | The width in pixels of a row in the image data |
Height | The height in pixels of all rows in the image data |
Format | The color format of the image data (eg COLOR_FORMAT_ARGB32) Pass COLOR_FORMAT_UNKNOWN to use the window format |
Stride | The distance in bytes between each row of pixels (Optional) |
Invert | If True invert the image so the first row is the bottom and the last row is the top |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
function GraphicsWindowImageToStream(Handle:TWindowHandle; X,Y:LongWord; Stream:TStream; Width,Height,Format,Stride:LongWord; Invert:Boolean):LongWord;
Handle | The handle of the window to get from |
---|---|
X | The left starting point of the image (relative to current viewport) |
Y | The top starting point of the image (relative to current viewport) |
Stream | A stream large enough to hold the image in a contiguous block of pixel rows |
Width | The width in pixels of a row of the image |
Height | The height in pixels of all rows of the image |
Format | The color format to store in the image data (eg COLOR_FORMAT_ARGB32) Pass COLOR_FORMAT_UNKNOWN to use the window format |
Stride | The distance in bytes between each row of pixels (Optional) |
Invert | If True invert the image so the first row is the bottom and the last row is the top |
Return | ERROR_SUCCESS if completed or another error code on failure |
Note | For Graphics Console functions, Viewport is based on screen pixels not characters. |
Graphics console helper functions
function GraphicsWindowGetCount(Console:PConsoleDevice):LongWord; inline;
Console | The console device to get the window count for |
---|---|
Return | The current number of console windows on the specified console device |
function GraphicsWindowGetActive(Console:PConsoleDevice):TWindowHandle; inline;
Console | The console device to get the active window for |
---|---|
Return | The window handle of the current active window or INVALID_HANDLE_VALUE on failure |
function GraphicsWindowCheck(Console:PConsoleDevice; Window:PGraphicsWindow):PGraphicsWindow; inline;
Console | The console device to search for the window |
---|---|
Window | The window entry to check for validity |
Return | The supplied window if successful or nil on failure |
Return to Unit Reference