Skip to main content

maskPixmapID

Type​

property

Summary​

Specifies the window ID of the X11 pixmap used to mask an image.

Syntax​

set the maskPixmapID of <image> to {empty | <windowID>}

Description​

Use the maskPixmapID property to pass to an external that needs to manipulate the image mask.

The maskPixmapID is provided by the operating system and indicates the pixmap used to mask an image. The mask is a 1-bit image map. Pixels in the image that correspond to a value of zero in the mask are transparent to mouse clicks, and pixels corresponding to a value of 1 can receive mouse clicks. If the maskPixmapID is empty, all the pixels in the image can receive mouse clicks (as though the mask consisted of all 1s).

This property is not supported on Mac OS and Windows systems.

Examples​

set the maskPixmapID of image ID 4500 to empty

Value​

NameTypeDescription

value

The maskPixmapID of a stack is an integer. By default, the maskPixmapID of newly created images is empty.

function: value

glossary: property, pixmap, external, mask

keyword: image, integer

object: stack, image

property: pixels, imagePixmapID

Compatibility and Support​

Introduced

LiveCode 1.0

OS

linux

Platforms

desktop

server

Thank you for your feedback!

Was this page helpful?