DarkBASIC Professional Help File

DX11 GET PIXELMAP RECT

Copies an rectangular sub-area of a PixelMap to a new PixelMap that is returned.
If the provided sub-map coordinates are invalid, a null pointer is returned.
It is valid to supply individual coordinates that lie outside of the pixelmap however; doing so will trim the resulting sub-map accordingly.
The call will only fail if the entire input area lies outside the pixel map dimensions.
Take note that you will be the owner of the returned sub-map, which should be subjected to DX11 DELETE PIXELMAP when you are done with it.

Syntax

    Return Dword = DX11 GET PIXELMAP RECT(pixelMap, x, y, width, height)

Parameters

    pixelMap

> Dword
> The pixelmap to get a sub-rectangle of.

    x

> Dword
> The X coordinate of the rectangle to extract.

    y

> Dword
> The Y coordinate of the rectangle to extract.

    width

> Dword
> The width of the rectangle to extract (relative to the X coordinate).

    height

> Dword
> The height of the rectangle to extract (relative to the Y coordinate).

Returns

A new PixelMap containing the copied data from the source map, or 0 if it could not be created.

See also

PIXELMAP Functions Menu
DX11 Function Categories