Layer¶

The Layer class manages layers.

A layer is a "displayed image": in addition to its image buffers (the main image and the province image), it has a parent-child tree, a display position, an opacity, and input events. Off-screen working images are handled by the Bitmap class, and processed with the ImageFunction class.

For how the three relate and when to use which, see Layer, Bitmap and ImageFunction.

Members for screen readers¶

When ElementsDialog.a11yLayers is true, Layers in the focus chain appear in the screen reader's accessibility tree (their name is hint). Adding the following members to a Layer changes how it is announced. All of them are optional; this is a convention in which the engine only reads the values (the Layer class itself does not define them).

Member	Meaning
`a11yName` / `a11yRole`	Name / role (same names as in ElementsDialog.setGameA11y). If either is present, the Layer appears even when it cannot take focus (headings, descriptive text)
`a11yValue` / `a11yDescription`	Value / additional description
`a11yStates`	An array or a string like `"checked,selected"`. `disabled` is also added based on enabled
`a11yHidden`	If true, removes the Layer together with its children (set this on Layers you expose yourself with `setGameA11y`)
`onA11yAction(action, arg)`	Receives actions from the screen reader. Return false to also run the default handling

The default handling is: "focus" calls focus, and "click" focuses the layer and then sends the Enter key. Value changes ("increment", "set_value", etc.) are delivered only to onA11yAction. If you implement these members as property getters, keep them cheap (they are re-read at most once every 150 ms). For the full specification, see Accessibility (screen reader) support.

Members¶

Layer¶

Constructor

Arguments

Arguments	Default	Description
`window`	` `	The window (an object of the Window class) that will own this layer. Once set, the window cannot be changed.
`parent`	` `	The layer to become the parent of this layer. Specify null to create a primary layer. A window can have only one primary layer, and when layers are used there must always be exactly one; it is the layer that is the parent of all other layers. However, some draw devices (configurable with Window.drawDevice) allow a window to have multiple primary layers. The parent of a layer can be changed with the Layer.parent property.

Description

Constructs a Layer object

Constructs an object of the Layer class.

A Layer is constructed in the hidden state.

parent¶

Property \ Access: r/w

Description

Parent layer

The parent layer object.

This property can also be set. Setting it makes the layer a child of the given layer.

A layer cannot become a child of a layer belonging to a different window or a different primary layer, nor a child of itself or of one of its own descendants.

When a layer is invalidated with invalidate, its child layers are not invalidated automatically; they remain as valid layers detached from the parent (with no parent). Detached layers are not shown on screen, but drawing methods and the like still work without throwing exceptions, so note that drawing to a stale reference can easily go unnoticed. To dispose of a whole subtree, invalidate the child layers individually (recursively).

children¶

Property \ Access: r

Description

Array of child layers

An array object containing the child layers.

Writing values to this array, or removing or adding items, is not reflected in the actual layer state. Treat it as read-only.

order¶

Property \ Access: r/w

Description

Relative order

The rank among sibling layers with the same parent. Smaller values are displayed further back.

Setting the value changes the rank among the siblings. Setting it sets the parent layer's Layer.absoluteOrderMode property to false.

absolute¶

Property \ Access: r/w

Description

Absolute order

The stacking order among sibling layers with the same parent. Smaller values are displayed further back.

Unlike the Layer.order property, the values need not be consecutive among siblings.

Setting the value changes the rank among the siblings. Setting it sets the parent layer's Layer.absoluteOrderMode property to true.

absoluteOrderMode¶

Property \ Access: r/w

Description

Whether absolute order mode is used

The stacking order mode of the immediate child layers. This property can also be set.

If false, relative ordering is used and the Layer.order property represents the rank.

If true, absolute ordering is used and the Layer.absolute property represents the rank.

visible¶

Property \ Access: r/w

Description

Whether visible

Whether the layer is visible. This property can also be set.

false makes it invisible; true makes it visible.

cached¶

Property \ Access: r/w

Description

Whether caching is used

Whether caching is used. This property can also be set.

With caching on, the layer keeps a pre-composited image of itself and all its child layers, and thereafter performs no compositing for itself and its children unless they change (when they change, the cache is rebuilt automatically).

With caching off, compositing is performed on every screen update.

Caching is off by default, but it is enabled automatically during transitions (this property does not, however, reflect caching that is enabled automatically, e.g. during transitions).

If you know that a layer's image and its children's images and states will not change, and the screen is redrawn frequently, enabling caching on that layer improves overall performance.

nodeVisible¶

Property \ Access: r

Description

Whether the node is visible

Whether the node is visible.

false if any of the ancestor layers is invisible.

true if all ancestor layers are visible.

neutralColor¶

Property \ Access: r/w

Description

Neutral color

The layer's neutral color, in 0xAARRGGBB format. This property can also be set.

When the Layer.type property is changed, the neutral color is set to the neutral color of that type.

The neutral color is the initial value used to fill the extended area when the layer image is enlarged.

Setting this value specifies the initial color used when the layer image is enlarged.

hasImage¶

Property \ Access: r/w

Description

Whether the layer has an image

Whether the layer has an image. This property can also be set.

If true, the layer has an image. This is the default.

If false, the layer's image is freed and the layer no longer has an image.

Setting the Layer.type property resets hasImage to true.

When the layer has no image and Layer.type is ltOpaque, the layer is displayed as if it were entirely filled with Layer.neutralColor.

For other types it is treated as fully transparent.

A layer with this property false is regarded as having opacity 0 (fully transparent) everywhere when Layer.hitType is htMask. Also, drawing and font operations are not possible on it.

Layers with this property false are normally used to group several child layers while being merely transparent themselves.

opacity¶

Property \ Access: r/w

Description

Opacity

The opacity of the layer. This property can be set.

The value is an integer from 0 to 255; larger values are more opaque.

window¶

Property \ Access: r

Description

Window object

The window object that owns this layer.

isPrimary¶

Property \ Access: r

Description

Whether this is the primary layer

Whether this layer is a primary layer.

The primary layer has no parent and is displayed at the very back.

left¶

Property \ Access: r/w

Description

Left edge

The left edge of the layer, in pixels in the parent layer's display coordinates.

This property can also be set.

See also: Layer.setPos

top¶

Property \ Access: r/w

Description

Top edge

The top edge of the layer, in pixels in the parent layer's display coordinates.

This property can also be set.

See also: Layer.setPos

width¶

Property \ Access: r/w

Description

Width

The display width of the layer, in pixels.

This property can also be set.

See also: Layer.setSize

height¶

Property \ Access: r/w

Description

Height

The display height of the layer, in pixels.

This property can also be set.

See also: Layer.setSize

imageLeft¶

Property \ Access: r/w

Description

Layer image left offset

The left edge of the layer's display offset, in pixels.

This property can also be set.

See also: Layer.setImagePos

imageTop¶

Property \ Access: r/w

Description

Layer image top offset

The top edge of the layer's display offset, in pixels.

This property can also be set.

See also: Layer.setImagePos

imageWidth¶

Property \ Access: r/w

Description

Image width

The width of the layer's image, in pixels.

This property can also be set.

See also: Layer.setImageSize

imageHeight¶

Property \ Access: r/w

Description

Image height

The height of the layer's image, in pixels.

This property can also be set.

See also: Layer.setSize

clipLeft¶

Property \ Access: r/w

Description

Clip rectangle left edge

The left edge of the drawing clip rectangle, in pixels.

This property can also be set.

See also: Layer.setClip

clipTop¶

Property \ Access: r/w

Description

Clip rectangle top edge

The top edge of the drawing clip rectangle, in pixels.

This property can also be set.

See also: Layer.setClip

clipWidth¶

Property \ Access: r/w

Description

Clip rectangle width

The width of the drawing clip rectangle, in pixels.

This property can also be set.

See also: Layer.setClip

clipHeight¶

Property \ Access: r/w

Description

Clip rectangle height

The height of the drawing clip rectangle, in pixels.

This property can also be set.

See also: Layer.setClip

type¶

Property \ Access: r/w

Description

Layer display type

The display type of the layer. This property can also be set.

**ltOpaque** or **ltCoverRect** disables per-pixel alpha blending. ltCoverRect and ltOpaque mean the same thing. If the Layer.opacity property is 255, the layer is displayed as a fully opaque rectangle. The mask image is ignored. The suitable drawing mode (specified with Layer.face) for this type is **dfOpaque**.
**ltAlpha** or **ltTransparent** enables per-pixel alpha blending. ltTransparent and ltAlpha mean the same thing. The mask image is used for transparency. The suitable drawing mode for this type is **dfAlpha**.
**ltAddAlpha** enables per-pixel additive alpha blending. The suitable drawing mode for this type is **dfAddAlpha**.
**ltAdditive** performs additive blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltSubtractive** performs subtractive blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltMultiplicative** performs multiplicative blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltDodge** performs dodge blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltDarken** performs darken blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltLighten** performs lighten blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.
**ltScreen** performs screen blending. The mask image is ignored. The suitable drawing mode for this type is **dfOpaque**.

For other layer display types, see Graphic System.

See also: Layer.face

face¶

Property \ Access: r/w

Description

Drawing mode

The drawing mode used for drawing to the layer. This property can also be set.

In Kirikiri 2.23 beta 1 and earlier, this was called the "drawing face".

**dfAlpha** or **dfBoth**: the image is treated as an image with an alpha channel when drawing. dfBoth and dfAlpha are equivalent. The corresponding layer types are ltTransparent or ltAlpha.
**dfAddAlpha**: the image is treated as an image with an additive alpha channel when drawing. The corresponding layer type is ltAddAlpha.
**dfOpaque** or **dfMain**: the layer image is treated as fully opaque when drawing. The corresponding layer types are ltOpaque or ltCoverRect, or layer types that perform arithmetic/logical operations such as ltAdditive.
**dfMask**: drawing targets the mask image (alpha channel).
**dfProvince**: drawing targets the province image.
**dfAuto**: the drawing mode is determined automatically from the current Layer.type property. A newly created layer's drawing mode is dfAuto.

Some methods cannot be used depending on the value of this property.

See also: Layer.type

holdAlpha¶

Property \ Access: r/w

Description

Whether to preserve the alpha channel

Whether to preserve the alpha channel when drawing. This property can also be set.

The default is false.

In Kirikiri 2.23 beta 1 and earlier, each drawing method had a parameter called hda that behaved like this property; since 2.23 beta 2 it has been separated out as a property.

For some drawing operations, when the Layer.face property is dfOpaque, this property specifies whether the image's alpha channel (mask image) is kept. For many methods, drawing is faster with this property set to false. If Layer.type is neither ltAlpha nor ltAddAlpha, the image's alpha channel is not used, so setting this property to false causes no problems. Note, however, that the alpha channel is destroyed when this property is false.

The following methods are not affected by this property.

Layer.loadImages

Layer.loadProvinceImage

Layer.setMainPixel

Layer.setMaskPixel

Layer.setProvincePixel

Layer.piledCopy

Layer.adjustGamma (the alpha channel is always preserved)

Layer.doGrayScale (the alpha channel is always preserved)

Layer.flipLR

Layer.flipUD

Layer.assignImages

The following methods are affected by this property.

imageModified¶

Property \ Access: r/w

Description

Whether the image was modified

Whether the layer's image has been modified. This property can also be set.

It is set to true automatically when you draw on the layer's image or change its size.

If you set this property to false, it becomes true when the layer's image is modified, so you can tell whether the image has been modified.

This property itself does not affect the layer's behavior.

hitType¶

Property \ Access: r/w

Description

Hit test type

The type of hit test for mouse events. This property can also be set.

**htProvince**: mouse events are received only in areas where the province image is nonzero.

**htMask**: mouse events are received only where the mask (opacity) image value is greater than or equal to the value specified by the Layer.hitThreshold property.

Mouse events that are not received are handled by layers further back.

The initial value is htMask.

hitThreshold¶

Property \ Access: r/w

Description

Hit test threshold

The threshold for the mouse event hit test. This property can also be set.

This property is effective only when the Layer.hitType property is htMask; mouse messages are received where the mask (opacity) image value is greater than or equal to this value.

0 makes all mouse messages received. 256 makes no mouse messages received.

The initial value is 16.

cursor¶

Property \ Access: r/w

Description

Mouse cursor

The layer's mouse cursor. This property can also be set.

You can specify a mouse cursor constant starting with cr, or the storage name of a mouse cursor with the .cur extension or an animated mouse cursor with the .ani extension.

cursorX¶

Property \ Access: r/w

Description

Mouse cursor x position

The x coordinate of the layer's mouse cursor, in pixels in display coordinates. This property can also be set.

When setting, setting the cursorX property alone does not move the mouse cursor. The cursor moves when the cursorY property is set afterward.

See also: Layer.setCursorPos

cursorY¶

Property \ Access: r/w

Description

Mouse cursor y position

The y coordinate of the layer's mouse cursor, in pixels in display coordinates. This property can also be set.

When setting, setting the cursorX property alone does not move the mouse cursor. The cursor moves when the cursorY property is set afterward.

See also: Layer.setCursorPos

hint¶

Property \ Access: r/w

Description

Hint

The layer's hint string. This property can also be set.

The hint string is shown near the mouse cursor when the cursor rests on the layer for a moment.

Specify an empty string to show no hint.

See also: Layer.showParentHint

showParentHint¶

Property \ Access: r/w

Description

Whether to inherit the parent's hint

Whether to inherit the parent layer's hint. This property can also be set.

If true and the Layer.hint property is an empty string, the ancestors are searched and the hint of the first layer that has one is shown as is. If Layer.hint is not empty, it is shown.

If false, Layer.hint is shown if it is not empty; if it is empty, no hint is shown.

focusable¶

Property \ Access: r/w

Description

Whether the layer can receive the focus

Whether the layer can receive the focus. This property can also be set.

If true, the layer can receive the focus.

If false, the layer cannot receive the focus.

prevFocusable¶

Property \ Access: r

Description

Previous focusable layer

Searches backward for a layer that can receive the focus.

null if there is no such layer.

nextFocusable¶

Property \ Access: r

Description

Next focusable layer

Searches forward for a layer that can receive the focus.

null if there is no such layer.

joinFocusChain¶

Property \ Access: r/w

Description

Whether to join the focus chain

Whether the layer joins the focus chain.

If true, the layer joins the focus chain: it appears in Layer.prevFocusable and the like, and the focus can be moved to it with the TAB key and so on.

If false, the layer does not join the focus chain, but it can still receive the focus through the Layer.focus method and the like.

focused¶

Property \ Access: r

Description

Whether the layer has the focus

Whether the layer has the focus.

true if it has the focus, false otherwise.

enabled¶

Property \ Access: r/w

Description

Whether enabled

Whether the layer is enabled (can be operated). This property can also be set.

If true, the layer is enabled and can receive the focus and so on.

If false, the layer is disabled and cannot receive the focus and so on.

nodeEnabled¶

Property \ Access: r

Description

Whether the layer node is enabled

Whether the layer node is enabled.

false if the layer itself is disabled or any of its ancestor layers is disabled.

Otherwise true.

attentionLeft¶

Property \ Access: r/w

Description

Attention position left edge

The left edge of the attention position, in pixels in display coordinates. This property can also be set.

See also: Layer.setAttentionPos / Layer.useAttention

attentionTop¶

Property \ Access: r/w

Description

Attention position top edge

The top edge of the attention position, in pixels in display coordinates. This property can also be set.

See also: Layer.setAttentionPos / Layer.useAttention

useAttention¶

Property \ Access: r/w

Description

Whether to use the attention information

Whether to use the attention information. This property can also be set.

If true, this layer's attention information is used.

If false, the attention information of the layer's parent (if any) is used.

imeMode¶

Property \ Access: r/w

Description

IME mode

The IME mode. This property can also be set.

When the layer receives the focus, the IME switches to the mode specified here.

The possible values are:

**imDisable**: the IME is disabled. Input through the IME is not possible, and the user cannot enable the IME either.
**imClose**: the IME is disabled. Unlike imDisable, the user can enable the IME.
**imOpen**: the IME is enabled.
**imDontCare**: the IME's enabled/disabled state is carried over from the previous state. The user can enable or disable the IME. For Japanese input, this is the usual mode for letting the user freely enter half-width / full-width characters.
**imSAlpha**: the IME is enabled in half-width alphabet input mode.
**imAlpha**: the IME is enabled in full-width alphabet input mode.
**imHira**: the IME is enabled in hiragana input mode.
**imSKata**: the IME is enabled in half-width katakana input mode.
**imKata**: the IME is enabled in full-width katakana input mode.
**imChinese**: the IME is enabled in a mode that accepts double-byte Chinese input. Not available in a Japanese environment.
**imSHanguel**: the IME is enabled in a mode that accepts single-byte Korean input. Not available in a Japanese environment.
**imHanguel**: the IME is enabled in a mode that accepts double-byte Korean input. Not available in a Japanese environment.

If not specified, imDisable is used.

On Windows, imDisable is implemented by detaching the input context (ImmAssociateContext(hwnd, NULL)). Therefore, while a layer with imDisable has the focus, pressing the half-width/full-width key does not open the IME. This is the difference from imClose. When the focus moves to a layer other than imDisable, the context is reattached automatically.

To turn off IME control altogether, use the command-line option -controlime=no (layers' imeMode is then never applied).

In SDL-based builds, the same meaning is achieved by enabling the OS text input only while a layer other than imDisable has the focus.

See also: Window.imeMode

callOnPaint¶

Property \ Access: r/w

Description

Whether to call the onPaint event

Whether to call the Layer.onPaint event. This property can also be set.

If true, the onPaint event is called just before the next drawing to the screen. After the onPaint event finishes, this property is automatically set back to false.

While it is false, the onPaint event does not occur.

The Layer.update method sets this property to true.

font¶

Property \ Access: r

Description

Font

An object of the Font class representing the font used for drawing with the Layer.drawText method.

name¶

Property \ Access: r/w

Description

Layer name

The layer name. This property can also be set.

The value set here does not affect the behavior of the Layer class.

mainImageBuffer¶

Property \ Access: r

Description

Main image buffer pointer

A pointer to the top-left corner of the image buffer of the main image (a 32bpp bitmap containing color and mask (opacity) information).

This property exists to give plugins and the like direct access to the image buffer.

It is returned as an integer; in plugins, cast it to an appropriate type (const unsigned long *, etc.) before use.

Do not write to the pointer obtained from this property. You can write to the pointer obtained from Layer.mainImageBufferForWrite.

NULL (0) is returned if no image is assigned to the layer.

The image size is given by the Layer.imageWidth and Layer.imageHeight properties.

For how to compute pointers, see Layer.mainImageBufferPitch.

mainImageBufferForWrite¶

Property \ Access: r

Description

Main image buffer pointer (for writing)

A pointer to the top-left corner of the image buffer of the main image (a 32bpp bitmap containing color and mask (opacity) information).

This property exists to give plugins and the like direct access to the image buffer.

It is returned as an integer; in plugins, cast it to an appropriate type (unsigned long *, etc.) before use.

Unlike Layer.mainImageBuffer, you can write to the pointer obtained from this property. Internally, Kirikiri shares identical images among multiple layers and so on; reading this property ends that sharing.

NULL (0) is returned if no image is assigned to the layer.

The image size is given by the Layer.imageWidth and Layer.imageHeight properties.

For how to compute pointers, see Layer.mainImageBufferPitch.

mainImageBufferPitch¶

Property \ Access: r

Description

Main image buffer pitch

The pitch of the image buffer of the main image (a 32bpp bitmap containing color and mask (opacity) information) (the number of bytes to the next scan line down).

This property exists to give plugins and the like direct access to the image buffer.

With tjs_uint32 as a 32-bit integer type and tjs_uint8 as an 8-bit (1-byte) integer type, a pointer to image position (x, y) can be computed in C as follows.

( (tjs_uint32*)( (tjs_uint8*)mainImageBuffer + y*mainImageBufferPitch )) + x

Note that this property returns the number of bytes to the next scan line, not the number of pixels. This value may be slightly larger than the number of bytes needed for exactly the image width.

Note that this property can be negative.

provinceImageBuffer¶

Property \ Access: r

Description

Province image buffer pointer

A pointer to the top-left corner of the image buffer of the province image (an 8bpp bitmap containing province information).

This property exists to give plugins and the like direct access to the image buffer.

It is returned as an integer; in plugins, cast it to an appropriate type (const unsigned char *, etc.) before use.

Do not write to the pointer obtained from this property. You can write to the pointer obtained from Layer.provinceImageBufferForWrite.

NULL (0) is returned if no image is assigned. In that case, the whole area must be treated as province number 0.

The image size is given by the Layer.imageWidth and Layer.imageHeight properties.

For how to compute pointers, see Layer.provinceImageBufferPitch.

provinceImageBufferForWrite¶

Property \ Access: r

Description

Province image buffer pointer (for writing)

A pointer to the top-left corner of the image buffer of the province image (an 8bpp bitmap containing province information).

This property exists to give plugins and the like direct access to the image buffer.

It is returned as an integer; in plugins, cast it to an appropriate type (unsigned char *, etc.) before use.

Unlike Layer.provinceImageBuffer, you can write to the pointer obtained from this property. Internally, Kirikiri shares identical images among multiple layers and so on; reading this property ends that sharing.

If no image is assigned to the layer, one is assigned automatically when this property is read, with the whole area initialized to province number 0.

The image size is given by the Layer.imageWidth and Layer.imageHeight properties.

For how to compute pointers, see Layer.provinceImageBufferPitch.

provinceImageBufferPitch¶

Property \ Access: r

Description

Province image buffer pitch

The pitch of the image buffer of the province image (an 8bpp bitmap containing province information) (the number of bytes to the next scan line down).

This property exists to give plugins and the like direct access to the image buffer.

With tjs_uint8 as an 8-bit (1-byte) integer type, a pointer to image position (x, y) can be computed in C as follows.

(tjs_uint8*)provinceImageBuffer + y*provinceImageBufferPitch + x

This value may be slightly larger than the number of bytes needed for exactly the image width.

Note that this property can be negative.

ignoreHintSensing¶

Property \ Access: r/w

Description

Whether to skip hint detection

Whether hint detection is skipped.

If set to true, no hint detection is performed for this layer.

If set to false, detection is performed.

See also: Window.onHintChanged

nodeFocusable¶

Property \ Access: r/w

Description

Whether the node can take the focus

Returns whether this layer node can have the focus. The result takes into account focusable in the ancestor hierarchy. Read-only.

See also: Layer.focusable

moveBefore¶

Method

Arguments

Arguments	Default	Description
`layer`	` `	The layer to move in front of. Only sibling layers (layers with the same parent) can be specified.

Description

Moves in front of the specified layer

Moves the layer in front of the specified layer in the stacking order.

This method sets the Layer.absoluteOrderMode property to false.

moveBehind¶

Method

Arguments

Arguments	Default	Description
`layer`	` `	The layer to move behind. Only sibling layers (layers with the same parent) can be specified.

Description

Moves behind the specified layer

Moves the layer behind the specified layer in the stacking order.

This method sets the Layer.absoluteOrderMode property to false.

bringToBack¶

Method

Description

Moves to the very back

Moves the layer to the very back among its siblings (layers with the same parent) in the stacking order.

Calling this method sets the parent layer's Layer.absoluteOrderMode property to false.

bringToFront¶

Method

Description

Moves to the very front

Moves the layer to the very front among its siblings (layers with the same parent) in the stacking order.

Calling this method sets the parent layer's Layer.absoluteOrderMode property to false.

loadImages¶

Method

Arguments

Arguments	Default	Description
`image`	` `	The image storage to load. If an image storage exists whose name is this storage name (without the extension) followed by _m, it is loaded as the mask (opacity) image. If an image storage exists whose name is this storage name (without the extension) followed by _p, it is loaded as the province image.
`colorkey`	`clNone`	The color key (transparent color) of the image to load. Specifying a color in 0xRRGGBB format makes that color the color key. Specifying `clPalIdx` plus a palette index makes that palette index transparent (for images with 256 colors or fewer). Specifying `clAdapt` automatically makes the color used most often in the top line of the image transparent. Specifying `clAlphaMat` plus a color value in 0xRRGGBB format composites the image onto that color using alpha blending (the ltAlpha method). For example, specifying (clAlphaMat + 0xffffff) composites the loaded image onto white. The result is a fully opaque image (note that although the image becomes fully opaque, the tag information is not changed at all in this mode).

Return value

Dictionary of tag information

Description

Loads an image

Loads an image into the layer.

This method changes the layer's image size, but does not change the layer's display size unless the image is smaller than the current display size.

The return value is a dictionary of tag information (information about the image itself, such as its layer type and display position).

If the image has no tag information, null is returned.

In the current version, only the PNG and TLG5/6 formats can carry tag information. For the available information, see Image Format Converter.

loadProvinceImage¶

Method

Arguments

Arguments	Default	Description
`image`	` `	The image storage to load as the province image.

Description

Loads a province image

Loads the layer's province image. The other images are left unchanged.

An exception is thrown if the image to load differs in size from the layer's image size.

getMainPixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the color from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the color from.

Return value

Color value in 0xRRGGBB format

Description

Gets a color from the main image

Gets the color at any position in the layer's main image (the image that holds the colors).

An exception is thrown if the position is invalid (out of range) in image coordinates.

setMainPixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the color at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the color at.
`color`	` `	The color to set, in 0xRRGGBB format.

Description

Sets a color in the main image

Sets the color at any position in the layer's main image (the image that holds the colors).

An exception is thrown if the position is invalid (out of range) in image coordinates.

getMaskPixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Return value

Mask image value (0 to 255)

Description

Gets a value from the mask image

Gets the value (0 to 255) at any position in the layer's mask image (the image that holds the opacity).

An exception is thrown if the position is invalid (out of range) in image coordinates.

setMaskPixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Description

Sets a value in the mask image

Sets the value (0 to 255) at any position in the layer's mask image (the image that holds the opacity).

An exception is thrown if the position is invalid (out of range) in image coordinates.

getProvincePixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Return value

Province image value (0 to 255)

Description

Gets a value from the province image

Gets the value (0 to 255) at any position in the layer's province image.

An exception is thrown if the position is invalid (out of range) in image coordinates.

setProvincePixel¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Description

Sets a value in the province image

Sets the value (0 to 255) at any position in the layer's province image.

An exception is thrown if the position is invalid (out of range) in image coordinates.

getLayerAt¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`y`	` `	The y coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`exclude_self`	`false`	Whether to exclude this layer itself from the search. If false, this layer is included in the search. If true, this layer is excluded from the search and treated as if it did not exist. If omitted, false is assumed.
`get_disabled`	`false`	Whether to return disabled layer objects. If false and the layer at the position is disabled (e.g. its Layer.enabled property is false), null is returned. If true and the layer at the position is disabled, that layer object is returned. If omitted, false is assumed.

Return value

The layer object at the position. Returns null if there is no layer there, etc.

Description

Gets the layer at a position

Returns the layer object at the position given by x, y.

The hit test uses the same mechanism as for ordinary mouse events: the position is examined from the frontmost layer in the stacking order, and the first layer that is hit is returned.

Specifying true for the exclude_self argument excludes the layer that calls this method from the search.

See also: Layer.hitType / Layer.hitThreshold / Layer.onHitTest

releaseCapture¶

Method

Description

Releases the mouse capture

Releases the mouse event capture.

Mouse event capture is a feature whereby mouse events are sent exclusively to the layer that was under the mouse when a button was first pressed, until the button is released.

This method cancels that capture and returns to normal mouse event handling.

Calling this method releases the mouse capture for layers belonging to the same window, even if the layer calling the method differs from the layer being captured.

This method does nothing when no capture is active.

setPos¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.left property.
`top`	` `	The top edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.top property.
`width`	`void`	The width of the layer, in pixels. This value can also be read and set with the Layer.width property. If this argument and the height argument are omitted, only the position is changed using the left and top arguments.
`height`	`void`	The height of the layer, in pixels. This value can also be read and set with the Layer.height property. If this argument and the width argument are omitted, only the position is changed using the left and top arguments.

Description

Sets the layer's display position

Sets the display position of the layer.

setClip¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge of the clip rectangle (in the layer's image coordinates), in pixels. This value can also be read and set with the Layer.clipLeft property.
`top`	` `	The top edge of the clip rectangle (in the layer's image coordinates), in pixels. This value can also be read and set with the Layer.clipTop property.
`width`	`void`	The width of the clip rectangle, in pixels. This value can also be read and set with the Layer.clipWidth property.
`height`	`void`	The height of the clip rectangle, in pixels. This value can also be read and set with the Layer.clipHeight property.

Description

Sets the drawing clip rectangle

Sets the layer's drawing clip rectangle.

Drawing to the layer is restricted to this clip rectangle (anything outside the rectangle is not drawn). Some methods, however, such as Layer.flipLR and Layer.flipUD, are not affected by the clip rectangle.

Initially, the clip rectangle covers the whole layer image (you can draw over the entire layer).

The clip rectangle is reset to its initial value when an image is loaded, the image size changes, or the layer's display type changes.

Calling this method with no arguments also resets the clip rectangle to its initial value.

setSize¶

Method

Arguments

Arguments	Default	Description
`width`	` `	The display width of the layer, in pixels. This value can also be read and set with the Layer.width property.
`height`	` `	The display height of the layer, in pixels. This value can also be read and set with the Layer.height property.

Description

Sets the layer's display size

Sets the display size of the layer.

setSizeToImageSize¶

Method

Description

Matches the display size to the image size

Makes the layer's display size the same as its image size.

Most operations that change the image size do not change the display size; this method makes the display size match the image size.

setImagePos¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge (x offset) of the image shown in the layer, in pixels. This value can also be read and set with the Layer.imageLeft property.
`top`	` `	The top edge (y offset) of the image shown in the layer, in pixels. This value can also be read and set with the Layer.imageTop property.

Description

Sets the layer image offset

Sets the layer image offset.

The layer image can be larger than the layer's display size, but then not all of it can be shown, so you specify the display offset with this method or the Layer.imageLeft and Layer.imageTop properties.

The offset is 0 or negative.

setImageSize¶

Method

Arguments

Arguments	Default	Description
`width`	` `	The width of the layer image, in pixels. This value can also be read and set with the Layer.imageWidth property.
`height`	` `	The height of the layer image, in pixels. This value can also be read and set with the Layer.imageHeight property.

Description

Sets the layer image size

Sets the size of the layer image.

When the size is enlarged, the layer's display size is not changed; when it is reduced, the display size is reduced as well.

independMainImage¶

Method

Arguments

Arguments	Default	Description
`copy`	`true`	Whether to copy the original image when ending the sharing. If true, the original image is copied. If false, it is not copied and the image contents are undefined.

Description

Stops sharing the main image

Forcibly ends the sharing of the layer image.

When an image is copied wholesale to another layer, e.g. with assignImages, Kirikiri does not actually copy the image buffer; the layers share the same image instead.

Normally this sharing ends automatically just before the image is modified, but this method ends it forcibly.

If false is passed for the copy argument, sharing ends but the original image is not guaranteed to be carried over (the image contents become undefined); in exchange, ending the sharing is faster. When you are going to overwrite the entire layer image, you do not need the original image, so calling this method with false before drawing can be more efficient.

This method does nothing if the image is not shared.

independProvinceImage¶

Method

Arguments

Arguments	Default	Description
`copy`	`true`	Whether to copy the original image when ending the sharing. If true, the original image is copied. If false, it is not copied and the image contents are undefined.

Description

Stops sharing the province image

Forcibly ends the sharing of the province image.

When an image is copied wholesale to another layer, e.g. with assignImages, Kirikiri does not actually copy the image buffer; the layers share the same image instead.

Normally this sharing ends automatically just before the image is modified, but this method ends it forcibly.

If false is passed for the copy argument, sharing ends but the original image is not guaranteed to be carried over (the image contents become undefined); in exchange, ending the sharing is faster. When you are going to overwrite the entire layer image, you do not need the original image, so calling this method with false before drawing can be more efficient.

This method does nothing if the image is not shared.

fillRect¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge of the rectangle to fill (in image coordinates), in pixels.
`top`	` `	The top edge of the rectangle to fill (in image coordinates), in pixels.
`width`	` `	The width of the rectangle to fill (in image coordinates), in pixels.
`height`	` `	The height of the rectangle to fill (in image coordinates), in pixels.
`value`	` `	The color or value to fill with. Its meaning depends on the value of the Layer.face property. `dfAlpha (or dfBoth)` : Specify the opacity and color in 0xAARRGGBB format. Both the main image and the mask are filled. `dfAddAlpha` : Specify the opacity and color in 0xAARRGGBB format. Both the main image and the mask are filled. `dfOpaque (or dfMain)` : Specify the color in 0xRRGGBB format. When the Layer.holdAlpha property is true, only the main image is filled and the mask is left unchanged. When it is false, as with dfAlpha and dfAddAlpha, opacity and color are accepted in 0xAARRGGBB format and both the main image and the mask are filled. `dfMask` : Specify the mask (opacity) value (0 to 255). Only the mask is filled; the main image is left unchanged. `dfProvince` : Specify the province value (0 to 255). Only the province image is filled.

Description

Fills a rectangle

Fills the specified rectangle of the layer image in the specified way.

colorRect¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge of the rectangle to fill (in image coordinates), in pixels.
`top`	` `	The top edge of the rectangle to fill (in image coordinates), in pixels.
`width`	` `	The width of the rectangle to fill (in image coordinates), in pixels.
`height`	` `	The height of the rectangle to fill (in image coordinates), in pixels.
`value`	` `	The color or value to fill with. Its meaning depends on the value of the Layer.face property. `dfAlpha (or dfBoth)` : Specify the color in 0xRRGGBB format `dfAddAlpha` : Specify the color in 0xRRGGBB format `dfOpaque (or dfMain)` : Specify the color in 0xRRGGBB format `dfMask` : Specify the mask (opacity) value (0 to 255) `dfProvince` : Specify the province value (0 to 255) With dfOpaque, the mask information is ignored (whether it is preserved or destroyed depends on the Layer.holdAlpha property). With dfMask, the color information is left unchanged. With dfAlpha and a negative opa, this argument is ignored.
`opa`	`255`	The fill opacity (-255 to 0 to 255). This argument is ignored when the Layer.face property is dfMask or dfProvince (always fully opaque). Negative values are valid only when Layer.face is dfAlpha; in that case the value argument is ignored and opacity is removed from the image (-255 makes the rectangle fully transparent).

Description

Fills a rectangle semi-transparently

Fills the specified rectangle of the layer image in the specified way.

Unlike Layer.fillRect, you can specify an opacity to fill semi-transparently.

drawText¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in image coordinates), in pixels, of the origin where text drawing starts.
`y`	` `	The y coordinate (in image coordinates), in pixels, of the origin where text drawing starts.
`text`	` `	The text to draw.
`color`	` `	The text color in 0xRRGGBB format (24-bit). Note: Keep the upper 8 bits (alpha) at 0. If the upper 8 bits are nonzero (e.g. 0xFFFFFFFF intended as white), the value is interpreted as a "system color number" (internally via `TVPToActualColor`), resulting in an unintended color (usually nearly black). Specify opacity with the opa argument, not with color. (Colors for Layer.fillRect / Layer.colorRect / Layer.operateRect and so on are in 0xAARRGGBB format and include alpha, whereas the color for font drawing such as drawText / drawGlyph is 24-bit RGB.)
`opa`	`255`	The opacity of the text (-255 to 0 to 255). Negative values are valid only when Layer.face is dfAlpha; in that case opacity is removed in the shape of the text (the smaller the value, the stronger the effect).
`aa`	`true`	Whether to apply antialiasing. If true, antialiasing is applied. If false, it is not.
`shadowlevel`	`0`	The opacity of the shadow. The appropriate value depends on the shadowwidth argument. Specifying 0 draws no shadow.
`shadowcolor`	`0x000000`	The shadow color in 0xRRGGBB format.
`shadowwidth`	`0`	The width (blur) of the shadow. 0 is the sharpest (no blur); larger values blur the shadow more.
`shadowofsx`	`0`	The x offset of the shadow, in pixels. Specifying 0 draws the shadow directly beneath the text.
`shadowofsy`	`0`	The y offset of the shadow, in pixels. Specifying 0 draws the shadow directly beneath the text.

Description

Draws text

Draws text on the layer. Drawing is possible only when Layer.face is dfAlpha (or dfBoth), dfAddAlpha, or dfOpaque (or dfMain).

With dfOpaque (or dfMain), whether the destination mask is destroyed or preserved depends on the Layer.holdAlpha property.

The font specified by Layer.font is used.

drawGlyph¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in image coordinates), in pixels, of the origin where drawing starts.
`y`	` `	The y coordinate (in image coordinates), in pixels, of the origin where drawing starts.
`glyph`	` `	The glyph to draw.
`color`	` `	The text color in 0xRRGGBB format (24-bit). Note: As with the color of Layer.drawText, keep the upper 8 bits at 0 (passing 0xFFFFFFFF or similar is treated as a system color and gives an unintended color). Specify opacity with the opa argument.
`opa`	`255`	The opacity of the text (-255 to 0 to 255). Negative values are valid only when face is dfAlpha; in that case opacity is removed in the shape of the glyph (the smaller the value, the stronger the effect).
`aa`	`true`	Whether to apply antialiasing. If true, antialiasing is applied. If false, it is not.
`shadowlevel`	`0`	The opacity of the shadow. The appropriate value depends on the shadowwidth argument. Specifying 0 draws no shadow.
`shadowcolor`	`0x000000`	The shadow color in 0xRRGGBB format.
`shadowwidth`	`0`	The width (blur) of the shadow. 0 is the sharpest (no blur); larger values blur the shadow more.
`shadowofsx`	`0`	The x offset of the shadow, in pixels. Specifying 0 draws the shadow directly beneath the text.
`shadowofsy`	`0`	The y offset of the shadow, in pixels. Specifying 0 draws the shadow directly beneath the text.

Description

Draws a glyph

Draws a glyph on the layer.

The glyph is an array of the form glyph : Array[9] = [ width, height, originx, originy, incx, incy, inc, bitmap(Octet), colors ].

If the glyph's colors is omitted, 256 levels of gray are assumed.

drawShapedText¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate, in pixels, of the baseline origin to draw at.
`y`	` `	The y coordinate, in pixels, of the baseline origin to draw at.
`text`	` `	The string to draw.
`color`	` `	The text color in 0xAARRGGBB format (if the upper 8 alpha bits are omitted, the text is opaque).
`font`	`void`	The drawing attributes, given as one of the following. + A Font object … uses face (font specification), height (size in px), bold, italic, underline, strikeout, and angle (in tenths of a degree, counterclockwise; color emoji cannot be transformed and stay upright) + A string … uses this layer's font with only the face replaced + void (omitted) … uses this layer's Layer.font as is The face (font specification) is a font name declared in data/fonts.json, a storage path, or (on WINVER) the name of an installed system font. Specifying several separated by commas forms a fallback chain (for each code point, the first face that contains it is used; e.g. "メイリオ,Segoe UI Emoji").
`base`	`0`	The base direction. 0 = auto-detect / 1 = left-to-right horizontal (LTR) / 2 = right-to-left horizontal (RTL).
`count`	`-1`	If 0 or greater, draws only the first count "characters" in logical (reading) order (for typewriter-style display). A "character" here is a cluster that is treated as one unit when drawn, counted the same way as Layer.shapedTextCount (a ligature, a combining sequence, or an emoji ZWJ sequence counts as 1). Because the whole text is shaped before only the leading part is drawn, contextual glyph forms such as those in Arabic do not change midway through the display. If omitted (-1), the whole text is drawn.

Return value

Returns the advance width (in pixels) of the drawn portion, or -1 on failure.

Description

Draws text (shaping / unified font engine)

Draws text at the baseline origin (x, y) of the main image using the unified font engine glyphware (FreeType + HarfBuzz). This is a drawing path independent of Layer.drawText and supports BiDi (bidirectional text), complex-script shaping, and font fallback (Arabic, Hebrew, etc.). The return value is the advance width (in pixels) of the drawn portion.

Note: This is a new path that coexists with the existing drawText for a gradual migration. To switch the behavior of the existing drawText (cell-stepping one code point at a time) to glyphware, use Font.rasterizer (that path does not perform shaping).

drawShapedTextArea¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The left edge of the rectangle, in pixels.
`y`	` `	The top edge of the rectangle, in pixels.
`width`	` `	The width of the rectangle, in pixels.
`height`	` `	The height of the rectangle, in pixels.
`text`	` `	The string to draw.
`color`	` `	The text color in 0xAARRGGBB format (if the upper 8 alpha bits are omitted, the text is opaque).
`font`	`void`	The drawing attributes (same as Layer.drawShapedText).
`base`	`0`	The base direction (0 = auto / 1 = LTR / 2 = RTL).
`count`	`-1`	If 0 or greater, draws only the first count "characters" (clusters) of the whole text (for typewriter-style display). Because the line breaks are determined for the whole text before drawing, lines are not rearranged (reflowed) midway through the display. If omitted (-1), the whole text is drawn.
`lineSpacing`	`0`	Extra pixels added between lines (may be negative).
`align`	`0`	The line alignment. 0 = left / 1 = center / 2 = right.

Return value

Returns a Dictionary describing the result (void on failure): %[ "height" => height used (px), "lines" => number of lines drawn, "count" => number of clusters actually drawn ]

Description

Draws text in a rectangle (shaping / simple line wrapping)

Draws text inside the rectangle (x, y, width, height) with simple line wrapping, using the unified font engine glyphware. \n (\r\n / \r) is treated as an explicit line break. Languages that separate words with spaces (English, etc.) wrap at word boundaries, and CJK languages such as Japanese wrap at character boundaries (with simple line-start / line-end prohibition rules). Lines extending past the bottom of the rectangle are not drawn, and drawing is clipped to the rectangle. The font's angle is ignored.

measureShapedText¶

Method

Arguments

Arguments	Default	Description
`text`	` `	The string to measure.
`font`	`void`	The drawing attributes (same as Layer.drawShapedText).
`base`	`0`	The base direction (0 = auto / 1 = LTR / 2 = RTL).

Return value

Returns a Dictionary with the measurement (void on failure). All values are in pixels relative to the baseline origin (0,0): %[ "width" => advance width, "left" => ink left, "top" => ink top (negative = above the baseline), "right" => ink right, "bottom" => ink bottom, "ascent" => ascent, "descent" => descent, "count" => number of drawn clusters (same as Layer.shapedTextCount) ]

Description

Measures text (shaping / unified font engine)

Measures text with the unified font engine glyphware and returns the result as a Dictionary. Nothing is drawn. Measurement uses the same font specification and shaping as Layer.drawShapedText.

shapedTextCount¶

Method

Arguments

Arguments	Default	Description
`text`	` `	The string to count.
`font`	`void`	The drawing attributes (same as Layer.drawShapedText; the cluster count can vary by font, e.g. depending on whether it has ligatures).
`base`	`0`	The base direction (0 = auto / 1 = LTR / 2 = RTL).

Return value

Returns the number of clusters, or -1 on failure.

Description

Gets the number of drawn characters (clusters)

Returns the number of "characters treated as one unit when drawn" (clusters) in the text. This is the same unit that the count argument of Layer.drawShapedText / Layer.drawShapedTextArea limits. A ligature, a base character plus combining characters, and an emoji ZWJ sequence each count as 1, so the result may differ from the number of code points (the string's length). Line-break characters split lines and are not counted themselves.

drawVerticalTextArea¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The left edge of the rectangle, in pixels.
`y`	` `	The top edge of the rectangle, in pixels.
`width`	` `	The width of the rectangle, in pixels (the length in the direction columns are laid out).
`height`	` `	The height of the rectangle, in pixels (the length of one column).
`text`	` `	The string to draw.
`color`	` `	The text color in 0xAARRGGBB format (if the upper 8 alpha bits are omitted, the text is opaque).
`font`	`void`	The drawing attributes (same as Layer.drawShapedText).
`count`	`-1`	If 0 or greater, draws only the first count "characters" (clusters) of the whole text (for typewriter-style display). Because the line breaks are determined for the whole text before the limit is applied, columns are not rearranged (reflowed) midway through the display. Spaces between Latin words are not counted here (the unit counted is the drawn characters themselves). If omitted (-1), the whole text is drawn.
`lineSpacing`	`0`	Extra pixels added between columns (lines) (may be negative).
`options`	`void`	Layout options as a Dictionary (optional). Keys not specified keep their defaults: + "orientation" => upright / sideways. 0 = Japanese upright, Latin sideways (default) / 1 = all upright / 2 = all sideways + "verticalLr" => if true, columns proceed left to right (default false = right to left) + "punctuation" => applies punctuation spacing compression (JLReq spacing table) (default true; false = solid setting) + "latinGap" => inserts space between Japanese and Latin text (default true) + "hanging" => lets punctuation at the end of a line hang outside the text area (hanging punctuation; default false) + "justify" => justifies line ends (default true). Even when false, compression for overflowing lines is still applied + "letterSpacing" => letter spacing as a real number in em units (default 0)

Return value

Returns a Dictionary describing the result (void on failure): %[ "width" => width used (px; the extent in the direction columns are laid out), "lines" => number of columns drawn, "count" => number of clusters actually drawn, "totalCount" => total number of clusters without the count limit ]

Description

Draws vertical text in a rectangle (shaping / Japanese vertical writing)

Draws text inside the rectangle (x, y, width, height) in vertical text (Japanese vertical writing), using the unified font engine glyphware. This path is separate from the horizontal Layer.drawShapedTextArea: Japanese characters are set upright and Latin text is rotated sideways, and punctuation (commas, periods, brackets) spacing, line-start / line-end prohibition rules, and pushing in / pushing out are handled according to the spacing amounts of the Japanese layout rules (JLReq).

The column length is height, and the column advance (line pitch) is "font size + lineSpacing". By default (vertical, right to left), the first column is at the right edge of the rectangle and columns proceed leftward. Columns that do not fit in the rectangle are not drawn, and drawing is clipped to the rectangle. \n (\r\n / \r) is treated as an explicit line break (paragraph separator).

Only body text is supported. Ruby, tate-chu-yoko (horizontal-in-vertical), emphasis dots, warichu (inline notes), fixed-width character fitting, and multi-column layout are not supported. The font's angle, underline, and strikeout are ignored.

measureVerticalTextArea¶

Method

Arguments

Arguments	Default	Description
`width`	` `	The width of the rectangle, in pixels.
`height`	` `	The height of the rectangle, in pixels.
`text`	` `	The string to measure.
`font`	`void`	The drawing attributes (same as Layer.drawShapedText).
`count`	`-1`	If 0 or greater, only the first count clusters are measured (if omitted (-1), the whole text).
`lineSpacing`	`0`	Extra pixels added between columns (lines) (may be negative).
`options`	`void`	Layout options as a Dictionary (same as Layer.drawVerticalTextArea).

Return value

Returns a Dictionary with the measurement (void on failure). Its contents are the same as the return value of Layer.drawVerticalTextArea.

Description

Measures vertical text in a rectangle

Performs the same layout as Layer.drawVerticalTextArea without drawing, and returns the result as a Dictionary. Use it to find out, before drawing, how many columns are needed and how many characters there are in total.

copyRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	The left edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dtop`	` `	The top edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to copy (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to copy (in the source layer's image coordinates), in pixels.

Description

Copies a rectangle

Copies a rectangular area of the specified source layer to the specified position in this layer.

Which images are copied depends on the Layer.face property of the destination layer (the layer calling the method).

**dfAlpha** (or dfBoth) : The main image and the mask image are copied

**dfAddAlpha** : The main image and the mask image are copied

**dfOpaque** (or dfMain) : If the Layer.holdAlpha property is true, only the main image is copied (the mask image is not). If false, the main image and the mask image are copied

**dfMask** : Only the mask image is copied (the main image is not)

**dfProvince** : Only the province image is copied (the mask and main images are not)

The Layer.face property of the source layer is ignored.

This method is not affected by Layer.holdAlpha (with dfAlpha or dfAddAlpha, the mask image is also copied regardless of holdAlpha)

copy9Patch¶

Method

Arguments

Arguments	Default	Description
`src`	` `	The source layer object. An object of the Bitmap class can also be specified.

Return value

Margin information

Description

Copies an image using 9-patch (1.3.0 and later)

Copies an image using 9-patch (slicing).

The returned margin information is an object of the Rect class.

piledCopy¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	The left edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dtop`	` `	The top edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`src`	` `	The source layer object.
`sleft`	` `	The left edge of the rectangle to copy (in the source layer's display coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to copy (in the source layer's display coordinates), in pixels.
`swidth`	` `	The width of the rectangle to copy (in the source layer's display coordinates), in pixels.
`sheight`	` `	The height of the rectangle to copy (in the source layer's display coordinates), in pixels.

Description

Copies the composited image of layers

Composites the specified rectangular area of the source layer together with its child layers, and copies the resulting image to the specified position in this layer.

This method is not affected by the Layer.face property of either the source or the destination layer.

operateRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	The left edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dtop`	` `	The top edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to blend (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to blend (in the source layer's image coordinates), in pixels.
`mode`	`omAuto`	The blend mode. `omAuto`: the kind of blend is determined automatically from the source layer's Layer.type property. `omPsNormal`: Photoshop-compatible alpha blending. `omPsAdditive`: Photoshop-compatible Linear Dodge blending. `omPsSubtractive`: Photoshop-compatible Linear Burn blending. `omPsMultiplicative`: Photoshop-compatible Multiply blending. `omPsScreen`: Photoshop-compatible Screen blending. `omPsOverlay`: Photoshop-compatible Overlay blending. `omPsHardLight`: Photoshop-compatible Hard Light blending. `omPsSoftLight`: Photoshop-compatible Soft Light blending. `omPsColorDodge`: Photoshop-compatible Color Dodge blending. `omPsColorDodge5`: Color Dodge blending compatible with Photoshop 5.x and earlier. `omPsColorBurn`: Photoshop-compatible Color Burn blending. `omPsLighten`: Photoshop-compatible Lighten blending. `omPsDarken`: Photoshop-compatible Darken blending. `omPsDifference`: Photoshop-compatible Difference blending. `omPsDifference5`: Difference blending compatible with Photoshop 5.x and earlier. `omPsExclusion`: Photoshop-compatible Exclusion blending. `omAdditive`: additive blending. `omSubtractive`: subtractive blending. `omMultiplicative`: multiplicative blending. `omDodge`: dodge blending. `omDarken`: darken blending. `omLighten`: lighten blending. `omScreen`: screen blending. `omAlpha`: alpha blending. `omAddAlpha`: additive alpha blending. `omOpaque`: the alpha information of src is ignored and src is always treated as fully opaque.
`opa`	`255`	The strength of the blend (0 to 255).

Description

Blends a rectangle

Blends a rectangular area of the specified source layer onto the specified position in this layer using the specified mode.

The Layer.face property of both the destination layer (the one calling the method) and the source layer is ignored.

If the destination layer's Layer.holdAlpha property is false, arithmetic blends (omAdditive / omSubtractive / omMultiplicative / omDodge / omDarken / omLighten / omScreen and the omPs modes) do not preserve the destination's mask (alpha) information, and the resulting mask is an undefined value that differs by mode (e.g. 0 for multiply, dodge, and lighten/darken; 255 for screen). If you want to keep the mask, for example when blending onto an ltAlpha layer, set holdAlpha to true.

If omAuto is specified for mode, the kind of blend is determined automatically from the source layer's Layer.type property.

stretchCopy¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	The left edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dtop`	` `	The top edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dwidth`	` `	The width of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dheight`	` `	The height of the destination rectangle (in the destination layer's image coordinates), in pixels.
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to copy (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to copy (in the source layer's image coordinates), in pixels.
`type`	`stNearest`	The scaling type. `stNearest` : Nearest neighbor `stFastLinear` : Low-precision linear interpolation (partially implemented) `stSemiFastLinear` : Fixed-point linear interpolation (1.3 and later) `stLinear` : Linear interpolation (implementation changed in 1.3) `stFastCubic` : Fixed-point cubic interpolation (1.3 and later) `stCubic` : Cubic interpolation (implementation changed in 1.3) `stFastLanczos2` : Fixed-point Lanczos interpolation over a 4x4 window (1.3 and later) `stLanczos2` : Lanczos interpolation over a 4x4 window (1.3 and later) `stFastLanczos3` : Fixed-point Lanczos interpolation over a 6x6 window (1.3 and later) `stLanczos3` : Lanczos interpolation over a 6x6 window (1.3 and later) `stFastSpline16` : Fixed-point 4x4 spline interpolation (1.3 and later) `stSpline16` : 4x4 spline interpolation (1.3 and later) `stFastSpline36` : Fixed-point 6x6 spline interpolation (1.3 and later) `stSpline36` : 6x6 spline interpolation (1.3 and later) `stFastAreaAvg` : Fixed-point area-average reduction. Cannot enlarge (1.3 and later) `stAreaAvg` : Area-average reduction. Cannot enlarge (1.3 and later) `stFastGaussian` : Fixed-point 4x4 Gaussian interpolation (1.3 and later) `stGaussian` : 4x4 Gaussian interpolation (1.3 and later) `stFastBlackmanSinc` : Fixed-point 8x8 Blackman-Sinc interpolation (1.3 and later) `stBlackmanSinc` : 8x8 Blackman-Sinc interpolation (1.3 and later) In terms of speed, stNearest > stFastLinear > stLinear > stCubic, but the faster the type, the lower the image quality. The methods from stCubic onward all give sufficiently high quality; choosing among them is largely a matter of taste. Gaussian interpolation, however, gives a somewhat blurry result. The difference between stFastLinear and the other linear interpolations (stSemiFastLinear and stLinear) is most noticeable when reducing. stFastLinear always samples the surrounding 4 pixels, whereas stSemiFastLinear and stLinear, when reducing, sample a range scaled so that it corresponds to 4 pixels at 1:1, i.e. a wider range of pixels, which gives higher quality (algorithmically, this is proper linear interpolation). For stFastLinear, you can additionally specify stRefNoClip with a bitwise OR, which allows colors to be sampled from outside the area of the bitmap being copied. Without it, pixels outside the source bitmap's range are never sampled, even if the source bitmap has room around it (colors outside the range are taken to be those of the nearest pixel inside the range).
`option`	`-1.0`	Added in 1.3. The sharpness for cubic interpolation. Currently meaningless for other interpolation methods. Increasing the sharpness value in the positive direction makes the result blurrier; increasing it in the negative direction makes it sharper.

Description

Copies with scaling

Copies a rectangle of the specified source layer to a rectangle of the destination (the layer calling the method). If the source and destination rectangles differ in size, the image is enlarged or reduced.

In the current version, linear interpolation with stFastLinear takes effect only when the Layer.face property of the destination layer (the one calling the method) is dfAlpha (or dfBoth) or dfAddAlpha. Linear interpolation is also possible when Layer.face is dfOpaque and the Layer.holdAlpha property is false.

Also, in the current version, stLinear and stCubic are effective only when no horizontal / vertical flipping is involved and the destination rectangle does not extend beyond the layer.

If the Layer.face property of the destination layer (the one calling the method) is dfAlpha (or dfBoth) or dfAddAlpha, both the main image and the mask image are copied.

With dfOpaque (or dfMain), only the main image is copied when the Layer.holdAlpha property is true, and both the main image and the mask image are copied when it is false.

operateStretch¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	The left edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dtop`	` `	The top edge of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dwidth`	` `	The width of the destination rectangle (in the destination layer's image coordinates), in pixels.
`dheight`	` `	The height of the destination rectangle (in the destination layer's image coordinates), in pixels.
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to blend (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to blend (in the source layer's image coordinates), in pixels.
`mode`	`omAuto`	The blend mode. `omAuto`: the kind of blend is determined automatically from the source layer's Layer.type property. `omPsNormal`: Photoshop-compatible alpha blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsAdditive`: Photoshop-compatible Linear Dodge blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsSubtractive`: Photoshop-compatible Linear Burn blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsMultiplicative`: Photoshop-compatible Multiply blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsScreen`: Photoshop-compatible Screen blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsOverlay`: Photoshop-compatible Overlay blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsHardLight`: Photoshop-compatible Hard Light blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsSoftLight`: Photoshop-compatible Soft Light blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsColorDodge`: Photoshop-compatible Color Dodge blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsColorDodge5`: Color Dodge blending compatible with Photoshop 5.x and earlier (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsColorBurn`: Photoshop-compatible Color Burn blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsLighten`: Photoshop-compatible Lighten blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsDarken`: Photoshop-compatible Darken blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsDifference`: Photoshop-compatible Difference blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsDifference5`: Difference blending compatible with Photoshop 5.x and earlier (since 1.3, implemented for types other than stNearest and stFastLinear). `omPsExclusion`: Photoshop-compatible Exclusion blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omAdditive`: additive blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omSubtractive`: subtractive blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omMultiplicative`: multiplicative blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omDodge`: dodge blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omDarken`: darken blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omLighten`: lighten blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omScreen`: screen blending (since 1.3, implemented for types other than stNearest and stFastLinear). `omAlpha`: alpha blending. `omAddAlpha`: additive alpha blending. In this case, when the destination's Layer.face property is dfOpaque and the Layer.holdAlpha property is false, linear interpolation is available by specifying stFastLinear for the type argument. `omOpaque`: the alpha information of src is ignored and src is always treated as fully opaque. In this case, when the destination's Layer.face property is dfOpaque and the Layer.holdAlpha property is false, linear interpolation is available by specifying stFastLinear for the type argument.
`opa`	`255`	The strength of the blend (0 to 255).
`type`	`stNearest`	The scaling type. `stNearest` : Nearest neighbor `stFastLinear` : Low-precision linear interpolation (partially implemented) `stSemiFastLinear` : Fixed-point linear interpolation (1.3 and later) `stLinear` : Linear interpolation (implementation changed in 1.3) `stFastCubic` : Fixed-point cubic interpolation (1.3 and later) `stCubic` : Cubic interpolation (implementation changed in 1.3) `stFastLanczos2` : Fixed-point Lanczos interpolation over a 4x4 window (1.3 and later) `stLanczos2` : Lanczos interpolation over a 4x4 window (1.3 and later) `stFastLanczos3` : Fixed-point Lanczos interpolation over a 6x6 window (1.3 and later) `stLanczos3` : Lanczos interpolation over a 6x6 window (1.3 and later) `stFastSpline16` : Fixed-point 4x4 spline interpolation (1.3 and later) `stSpline16` : 4x4 spline interpolation (1.3 and later) `stFastSpline36` : Fixed-point 6x6 spline interpolation (1.3 and later) `stSpline36` : 6x6 spline interpolation (1.3 and later) `stFastAreaAvg` : Fixed-point area-average reduction. Cannot enlarge (1.3 and later) `stAreaAvg` : Area-average reduction. Cannot enlarge (1.3 and later) `stFastGaussian` : Fixed-point 4x4 Gaussian interpolation (1.3 and later) `stGaussian` : 4x4 Gaussian interpolation (1.3 and later) `stFastBlackmanSinc` : Fixed-point 8x8 Blackman-Sinc interpolation (1.3 and later) `stBlackmanSinc` : 8x8 Blackman-Sinc interpolation (1.3 and later) In terms of speed, stNearest > stFastLinear > stLinear > stCubic, but the faster the type, the lower the image quality. The methods from stCubic onward all give sufficiently high quality; choosing among them is largely a matter of taste. Gaussian interpolation, however, gives a somewhat blurry result. The difference between stFastLinear and the other linear interpolations (stSemiFastLinear and stLinear) is most noticeable when reducing. stFastLinear always samples the surrounding 4 pixels, whereas stSemiFastLinear and stLinear, when reducing, sample a range scaled so that it corresponds to 4 pixels at 1:1, i.e. a wider range of pixels, which gives higher quality (algorithmically, this is proper linear interpolation). For stFastLinear, you can additionally specify stRefNoClip with a bitwise OR, which allows colors to be sampled from outside the area of the bitmap being copied. Without it, pixels outside the source bitmap's range are never sampled, even if the source bitmap has room around it (colors outside the range are taken to be those of the nearest pixel inside the range).
`option`	`-1.0`	Added in 1.3. The sharpness for cubic interpolation. Currently meaningless for other interpolation methods. Increasing the sharpness value in the positive direction makes the result blurrier; increasing it in the negative direction makes it sharper.

Description

Blends with scaling

Blends a rectangle of the specified source layer onto a rectangle of the destination (the layer calling the method). If the source and destination rectangles differ in size, the image is enlarged or reduced.

For the fact that arithmetic blends do not preserve the destination's mask (alpha) information when the Layer.holdAlpha property is false, see Layer.operateRect.

If omAuto is specified for mode, the kind of blend is determined automatically from the source layer's Layer.type property.

affineCopy¶

Method

Arguments

Arguments	Default	Description
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to copy (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to copy (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to copy (in the source layer's image coordinates), in pixels.
`affine`	` `	How the following six arguments (parameters A to F) are interpreted. If true, the six parameters are interpreted as follows. `A : a of the 2D affine transformation matrix` `B : b of the 2D affine transformation matrix` `C : c of the 2D affine transformation matrix` `D : d of the 2D affine transformation matrix` `E : tx of the 2D affine transformation matrix` `F : ty of the 2D affine transformation matrix` The affine transformation maps a source image position (x, y) (with the top-left corner of the source rectangle at (0, 0)) to the destination image position (x', y') by the following formulas. x' = ax + cy + tx y' = bx + dy + ty If false, the six parameters are interpreted as follows. These parameters also accept real numbers. `A : X coordinate (x0), in destination image coordinates, of the top-left corner of the source rectangle` `B : Y coordinate (y0), in destination image coordinates, of the top-left corner of the source rectangle` `C : X coordinate (x1), in destination image coordinates, of the top-right corner of the source rectangle` `D : Y coordinate (y1), in destination image coordinates, of the top-right corner of the source rectangle` `E : X coordinate (x2), in destination image coordinates, of the bottom-left corner of the source rectangle` `F : Y coordinate (y2), in destination image coordinates, of the bottom-left corner of the source rectangle` If false, the destination position (x3, y3) corresponding to the bottom-right corner of the source is computed automatically by the following formulas. x3 = x1 - x0 + x2 y3 = y1 - y0 + y2
`A`	` `	Parameter A. Its interpretation depends on the affine argument.
`B`	` `	Parameter B. Its interpretation depends on the affine argument.
`C`	` `	Parameter C. Its interpretation depends on the affine argument.
`D`	` `	Parameter D. Its interpretation depends on the affine argument.
`E`	` `	Parameter E. Its interpretation depends on the affine argument.
`F`	` `	Parameter F. Its interpretation depends on the affine argument.
`type`	`stNearest`	The affine transformation type. `stNearest` : Nearest neighbor `stFastLinear` : Low-precision linear interpolation (partially implemented) `stLinear` : Linear interpolation (not implemented) `stCubic` : Cubic interpolation (not implemented) For stFastLinear, stLinear, and stCubic, you can additionally specify stRefNoClip with a bitwise OR, which allows colors to be sampled from outside the area of the bitmap being copied. Without it, pixels outside the source bitmap's range are never sampled, even if the source bitmap has room around it (colors outside the range are taken to be those of the nearest pixel inside the range).
`clear`	`false`	Whether to clear the area of the destination layer surrounding the transformed image with the color and opacity given by the Layer.neutralColor property. If true, it is cleared; if omitted or false, it is not. The cleared area can also be restricted with the Layer.setClip method. This clearing feature avoids the waste of first clearing the destination layer and then overwriting it with the affine-transformed image (clearing the parts that are about to be overwritten anyway).

Description

Copies with an affine transformation

Copies a rectangle of the specified source layer to the destination (the layer calling the method) while applying an affine transformation.

With the affine argument, you can choose whether to give the transformation as a 2D affine transformation matrix or to specify the transformed points directly.

In the current version, linear interpolation with stFastLinear takes effect only when the Layer.face property of the destination layer (the one calling the method) is dfAlpha (or dfBoth) or dfAddAlpha. Linear interpolation is also possible when Layer.face is dfOpaque and the Layer.holdAlpha property is false.

If the Layer.face property of the destination layer (the one calling the method) is dfAlpha (or dfBoth) or dfAddAlpha, both the main image and the mask image are copied.

If the Layer.face property of the destination layer (the one calling the method) is dfOpaque (or dfMain), only the main image is copied when the Layer.holdAlpha property is true, and both the main image and the mask image are copied when it is false.

The transformation by a 2D affine transformation matrix takes the top-left corner of the source rectangle as the origin (0, 0) and is defined as follows.

A 2D affine transformation can perform scaling, rotation, shearing (skewing), translation, flipping, or any combination of these.

Methods that perform 2D affine transformations also let you specify the transformation by giving the transformed vertices directly instead of a 2D affine matrix, but even then, transformations that cannot be expressed as a 2D affine transformation are not possible.

In affine transformations, a pixel is regarded as having a size of 1.0 × 1.0. That is, the pixel at (0, 0) is regarded as occupying the range (-0.5, -0.5) - (0.5, 0.5).

operateAffine¶

Method

Arguments

Arguments	Default	Description
`src`	` `	The source layer object. An object of the Bitmap class can also be specified (1.1.0 and later).
`sleft`	` `	The left edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`stop`	` `	The top edge of the rectangle to blend (in the source layer's image coordinates), in pixels.
`swidth`	` `	The width of the rectangle to blend (in the source layer's image coordinates), in pixels.
`sheight`	` `	The height of the rectangle to blend (in the source layer's image coordinates), in pixels.
`affine`	` `	How the following six arguments (parameters A to F) are interpreted. If true, the six parameters are interpreted as follows. `A : a of the 2D affine transformation matrix` `B : b of the 2D affine transformation matrix` `C : c of the 2D affine transformation matrix` `D : d of the 2D affine transformation matrix` `E : tx of the 2D affine transformation matrix` `F : ty of the 2D affine transformation matrix` The affine transformation maps a source image position (x, y) (with the top-left corner of the source rectangle at (0, 0)) to the destination image position (x', y') by the following formulas. x' = ax + cy + tx y' = bx + dy + ty If false, the six parameters are interpreted as follows. `A : X coordinate (x0), in destination image coordinates, of the top-left corner of the source rectangle` `B : Y coordinate (y0), in destination image coordinates, of the top-left corner of the source rectangle` `C : X coordinate (x1), in destination image coordinates, of the top-right corner of the source rectangle` `D : Y coordinate (y1), in destination image coordinates, of the top-right corner of the source rectangle` `E : X coordinate (x2), in destination image coordinates, of the bottom-left corner of the source rectangle` `F : Y coordinate (y2), in destination image coordinates, of the bottom-left corner of the source rectangle` If false, the destination position (x3, y3) corresponding to the bottom-right corner of the source is computed automatically by the following formulas. x3 = x1 - x0 + x2 y3 = y1 - y0 + y2
`A`	` `	Parameter A. Its interpretation depends on the affine argument.
`B`	` `	Parameter B. Its interpretation depends on the affine argument.
`C`	` `	Parameter C. Its interpretation depends on the affine argument.
`D`	` `	Parameter D. Its interpretation depends on the affine argument.
`E`	` `	Parameter E. Its interpretation depends on the affine argument.
`F`	` `	Parameter F. Its interpretation depends on the affine argument.
`mode`	`omAuto`	The blend mode. `omAuto`: the kind of blend is determined automatically from the source layer's Layer.type property. `omPsNormal`: Photoshop-compatible alpha blending (not implemented in the current version). `omPsAdditive`: Photoshop-compatible Linear Dodge blending (not implemented in the current version). `omPsSubtractive`: Photoshop-compatible Linear Burn blending (not implemented in the current version). `omPsMultiplicative`: Photoshop-compatible Multiply blending (not implemented in the current version). `omPsScreen`: Photoshop-compatible Screen blending (not implemented in the current version). `omPsOverlay`: Photoshop-compatible Overlay blending (not implemented in the current version). `omPsHardLight`: Photoshop-compatible Hard Light blending (not implemented in the current version). `omPsSoftLight`: Photoshop-compatible Soft Light blending (not implemented in the current version). `omPsColorDodge`: Photoshop-compatible Color Dodge blending (not implemented in the current version). `omPsColorDodge5`: Color Dodge blending compatible with Photoshop 5.x and earlier (not implemented in the current version). `omPsColorBurn`: Photoshop-compatible Color Burn blending (not implemented in the current version). `omPsLighten`: Photoshop-compatible Lighten blending (not implemented in the current version). `omPsDarken`: Photoshop-compatible Darken blending (not implemented in the current version). `omPsDifference`: Photoshop-compatible Difference blending (not implemented in the current version). `omPsDifference5`: Difference blending compatible with Photoshop 5.x and earlier (not implemented in the current version). `omPsExclusion`: Photoshop-compatible Exclusion blending (not implemented in the current version). `omAdditive`: additive blending (not implemented in the current version). `omSubtractive`: subtractive blending (not implemented in the current version). `omMultiplicative`: multiplicative blending (not implemented in the current version). `omDodge`: dodge blending (not implemented in the current version). `omDarken`: darken blending (not implemented in the current version). `omLighten`: lighten blending (not implemented in the current version). `omScreen`: screen blending (not implemented in the current version). `omAlpha`: alpha blending. `omAddAlpha`: additive alpha blending. In this case, when the destination's Layer.face property is dfOpaque and the Layer.holdAlpha property is false, linear interpolation is available by specifying stFastLinear for the type argument. `omOpaque`: the alpha information of src is ignored and src is always treated as fully opaque. In this case, when the destination's Layer.face property is dfOpaque and the Layer.holdAlpha property is false, linear interpolation is available by specifying stFastLinear for the type argument.
`opa`	`255`	The opacity of the blend (0 to 255).
`type`	`stNearest`	The affine transformation type. `stNearest` : Nearest neighbor `stFastLinear` : Low-precision linear interpolation (partially implemented) `stLinear` : Linear interpolation (not implemented) `stCubic` : Cubic interpolation (not implemented) In terms of speed, stNearest > stFastLinear > stLinear > stCubic, but the faster the mode, the lower the image quality. For stFastLinear, stLinear, and stCubic, you can additionally specify stRefNoClip with a bitwise OR, which allows colors to be sampled from outside the area of the bitmap being copied. Without it, pixels outside the source bitmap's range are never sampled, even if the source bitmap has room around it (colors outside the range are taken to be those of the nearest pixel inside the range).

Description

Blends with an affine transformation

Blends a rectangle of the specified source layer onto the destination (the layer calling the method) while applying an affine transformation.

For affine transformations, see also Layer.affineCopy.

For the fact that arithmetic blends do not preserve the destination's mask (alpha) information when the Layer.holdAlpha property is false, see Layer.operateRect.

If omAuto is specified for mode, the kind of blend is determined automatically from the source layer's Layer.type property.

doBoxBlur¶

Method

Arguments

Arguments	Default	Description
`xblur`	`1`	The horizontal blur range.
`yblur`	`1`	The vertical blur range.

Description

Applies a box blur

Applies a blur. The algorithm is a box blur.

A box blur takes the average brightness of the pixels within a "range" defined by the two parameters xblur and yblur. For example, with xblur=10 and yblur=2, the brightness of the pixels in the rectangle from -10 to 10 horizontally and -2 to 2 vertically around the target pixel is averaged, and the result becomes the final brightness of that pixel.

The area of the range is (xblur×2+1) × (yblur×2+1). In the current version, when this area is less than 256, a faster algorithm is used than when it is 256 or more.

When the Layer.face property is dfAlpha, a special algorithm for alpha blending is used, which is somewhat slower. With dfAddAlpha and the other drawing modes, a faster algorithm is used.

adjustGamma¶

Method

Arguments

Arguments	Default	Description
`rgamma`	`1.0`	The gamma value of the red component (0.0 to 1.0 to 9.0).
`rfloor`	`0`	The output floor of the red component (0 to 255).
`rceil`	`255`	The output ceiling of the red component (0 to 255).
`ggamma`	`1.0`	The gamma value of the green component (0.0 to 1.0 to 9.0).
`gfloor`	`0`	The output floor of the green component (0 to 255).
`gceil`	`255`	The output ceiling of the green component (0 to 255).
`bgamma`	`1.0`	The gamma value of the blue component (0.0 to 1.0 to 9.0).
`bfloor`	`0`	The output floor of the blue component (0 to 255).
`bceil`	`255`	The output ceiling of the blue component (0 to 255).

Description

Gamma correction

Applies gamma correction to the image.

A gamma value of 1.0 makes the gamma curve a straight line.

The output floor and output ceiling specify the minimum and maximum brightness of each component.

Setting the ceiling lower than the floor inverts the image.

This method refers to the Layer.face property. If it is dfAddAlpha, this method uses a special gamma correction routine for additive alpha. That routine applies gamma correction to the component of additive alpha that corresponds to alpha blending, but not to the component that corresponds to additive blending.

doGrayScale¶

Method

Arguments

Arguments	Default	Description
`rweight`	` `	The weight of the red component. Either omit all three weights or specify all three.
`gweight`	` `	The weight of the green component.
`bweight`	` `	The weight of the blue component.

Description

Converts to grayscale

Converts the image to grayscale.

If the arguments are omitted, BT.709 weights (0.2126 / 0.7152 / 0.0722) are used (the traditional behavior). Passing three weights allows arbitrary weighting. For example, BT.601 is doGrayScale(0.299, 0.587, 0.114).

The weights are treated as relative values: they are normalized internally to sum to 1 and then quantized to 8-bit fixed point (summing to 256). Therefore 0.299, 0.587, 0.114 and 76, 149, 29 give the same result. Because of the quantization, the result may differ from the theoretical value by up to about 1 (specifying the BT.709 weights explicitly gives exactly the same result as omitting the arguments).

An exception is thrown if a weight is negative or the weights sum to 0.

flipLR¶

Method

Description

Flips horizontally

Flips the image horizontally.

This method is not affected by the drawing clip rectangle set by the Layer.setClip method and the like (the whole layer image is always flipped).

It is also not affected by the Layer.face or Layer.holdAlpha properties.

flipUD¶

Method

Description

Flips vertically

Flips the image vertically.

This method is not affected by the drawing clip rectangle set by the Layer.setClip method and the like (the whole layer image is always flipped).

It is also not affected by the Layer.face or Layer.holdAlpha properties.

convertType¶

Method

Arguments

Arguments	Default	Description
`from`	` `	The drawing mode type to convert from.

Description

Converts the layer image representation

Converts the format of the layer image.

This method converts the image representation between types such as ltAlpha (dfAlpha) and ltAddAlpha (dfAddAlpha), "whose image representations differ but which can express the same things".

For example, simply changing the type of a layer displayed as ltAlpha to ltAddAlpha does not display correctly, because the alpha channel and color information are handled differently. You therefore need to use this method to convert from dfAlpha to dfAddAlpha.

The target image representation of this method is the one corresponding to the drawing mode specified by the Layer.face property (note that it is the drawing mode, not the layer type specified by Layer.type).

For the from argument, specify the drawing mode (a constant starting with df; see Layer.face) that corresponds to the source image representation. dfAuto cannot be specified for from.

The currently supported conversions are dfAlpha→dfAddAlpha and dfAddAlpha→dfAlpha. Converting dfAddAlpha→dfAlpha may lose color information.

This method is not affected by the drawing clip rectangle (the whole layer image is always affected).

update¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The left edge of the rectangle to update, in pixels in display coordinates.
`top`	` `	The top edge of the rectangle to update, in pixels in display coordinates.
`width`	` `	The width of the rectangle to update, in pixels in display coordinates.
`height`	` `	The height of the rectangle to update, in pixels in display coordinates.

Description

Updates the image

Forces the layer to be drawn to the screen.

Screen updates happen automatically when drawing methods and the like are called, but this method forces drawing to the screen.

If all arguments are omitted, the whole layer is redrawn.

This method sets the Layer.callOnPaint property to true.

No matter how many times this method is called before the screen is actually drawn, the screen is drawn only once (requests are cached).

setCursorPos¶

Method

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate of the mouse cursor (in this layer's display coordinates), in pixels. This value can also be set and read with the Layer.cursorX property.
`y`	` `	The y coordinate of the mouse cursor (in this layer's display coordinates), in pixels. This value can also be set and read with the Layer.cursorY property.

Description

Sets the mouse cursor position (layer coordinates)

Sets the mouse cursor position in this layer's display coordinates.

⚠ It has the same name as Window.setCursorPos, but that one uses drawing-area coordinates, a different coordinate system.

focus¶

Method

Arguments

Arguments	Default	Description
`direction`	`true`	The value passed as the direction argument of the Layer.onBeforeFocus and Layer.onFocus events.

Description

Sets the focus

Gives the focus to the layer. When a layer receives the focus, it can accept keyboard input.

focusPrev¶

Method

Return value

The layer object that newly gained the focus

Description

Moves the focus to the previous layer

Searches backward for a focusable layer and, if one is found, gives it the focus.

focusNext¶

Method

Return value

The layer object that newly gained the focus

Description

Moves the focus to the next layer

Searches forward for a focusable layer and, if one is found, gives it the focus.

setMode¶

Method

Description

Makes the layer modal

Sets a mode on the layer. When a mode is set (the layer becomes modal), only the layer's child layers can receive the focus and mouse messages.

removeMode¶

Method

Description

Ends the modal state

Ends the modal state set by Layer.setMode.

setAttentionPos¶

Method

Arguments

Arguments	Default	Description
`left`	` `	The x coordinate to attend to (in this layer's display coordinates), in pixels. This value can also be set and read with the Layer.attentionLeft property.
`top`	` `	The y coordinate to attend to (in this layer's display coordinates), in pixels. This value can also be set and read with the Layer.attentionTop property.

Description

Sets the attention position

Sets the attention position. The attention position is normally set to the position of the caret (the blinking bar that text editors and the like use to show where keyboard input goes). IME composition text is displayed at this attention position.

See also: Layer.useAttention

beginTransition¶

Method

Arguments

Arguments	Default	Description
`name`	` `	The transition name. By default, 'crossfade' (crossfade), 'universal' (universal transition), and 'scroll' (scroll transition) are defined.
`withchildren`	`true`	Whether child layers transition together. If true, the layer transitions together with its children. If false, only the layer calling the method transitions.
`transsrc`	`null`	The layer to switch to. Some transitions may not need it (e.g. those that transition on their own).
`options`	`%[ ]`	Transition options, as a dictionary. The required options depend on the kind of transition. Regardless of the kind of transition, the 'selfupdate' and 'callback' members can be specified as common options. If the 'selfupdate' member is true, Kirikiri no longer updates the screen automatically. In this case, the program must update the screen as needed, e.g. with the Layer.update method. This is useful when you want to synchronize drawing by the transition completely with drawing by the program. If a TJS2 method is specified for the 'callback' member, that method is called every time drawing actually takes place. This method (the callback) must return a 'tick' value of 0 or greater. Most transitions are driven by the 'tick' value, which is the actual time in milliseconds, but by implementing the callback to return any tick you like, you can rewind the transition effect to any point or fast-forward it midway, controlling the transition independently of real time. Most transitions treat the value specified by the 'time' option member as the end of the transition. So, for example, by specifying a suitable value such as 1000 for the 'time' option and returning values below 1000 from the callback, you can show the transition at any stage. Also, for most transitions, the transition stops when the 'tick' value reaches the value specified by the 'time' option, so if you do not want the transition to stop, always return a value below the one specified by 'time'.

Description

Starts a transition

Starts a transition.

With children=true, when the transition finishes, the entire parent-child tree is swapped with the transition source specified by transsrc.

With children=false, only the transition source layer and the layer that called the method (the transition destination layer) are swapped.

In either case, note that the swap takes place in the tree structure.

This method only starts the transition and returns immediately.

stopTransition¶

Method

Description

Stops a transition

Stops the transition in progress.

assignImages¶

Method

Arguments

Arguments	Default	Description
`src`	` `	The source layer.

Description

Copies images

Copies all of the main image, mask image, and province image of the layer specified by src.

The image size becomes the same as the source layer's image size. No other information is copied.

Although it is called a copy, in practice it just puts the layers into a state where "the same image is shared by two or more layers", so this method takes almost no time.

saveLayerImage¶

Method

Arguments

Arguments	Default	Description
`name`	` `	The name of the storage to save to.
`type`	`"bmp"`	The image format to save in, as a string. The current version supports the following formats. "bmp" or "bmp32" 32bpp BMP. The alpha channel (mask) is also saved. "bmp24" 24bpp BMP. The alpha channel (mask) is not saved. "bmp8" 8bpp BMP. The alpha channel (mask) is not saved. The image is color-reduced with 4×4 ordered dithering using a fixed 252-color palette. "jpg" JPEG. The alpha channel (mask) is not saved. The image is saved at 90% quality. "jpg###" JPEG. The alpha channel (mask) is not saved. The image is saved at the quality given by ###: "jpg010" is 10%, "jpg100" is 100%, "jpg080" is 80%. "png" 32bpp PNG. The alpha channel (mask) is also saved. "png24" 24bpp PNG. The alpha channel (mask) is not saved. "tlg5" 32bpp TLG5. The alpha channel (mask) is also saved. "tlg524" 24bpp TLG5. The alpha channel (mask) is not saved. "tlg6" 32bpp TLG6. The alpha channel (mask) is also saved. "tlg624" 24bpp TLG6. The alpha channel (mask) is not saved.

Description

Saves the image

Saves the image to the storage (file) specified by name, in the image format specified by type.

The layer's image is saved; the province image cannot be saved.

copyToBitmapFromMainImage¶

Method

Arguments

Arguments	Default	Description
`dest`	` `	The destination Bitmap object.

Description

Copies the image to a Bitmap

Copies the layer's main image to the Bitmap object specified by dest.

The image size becomes the same as the source layer's image size.

Although it is called a copy, in practice it just puts them into a state where "the same image is shared by two or more layers", so this method takes almost no time.

See also: Layer.copyFromBitmapToMainImage

copyFromBitmapToMainImage¶

Method

Arguments

Arguments	Default	Description
`src`	` `	The source Bitmap object.

Description

Copies an image from a Bitmap

Copies the image from the Bitmap object specified by src to the layer's main image.

The image size becomes the same as the source Bitmap object's image size.

Although it is called a copy, in practice it just puts them into a state where "the same image is shared by two or more layers", so this method takes almost no time.

See also: Layer.copyToBitmapFromMainImage

dump¶

Method

Arguments

Arguments	Default	Description
`level`	`0`	The depth of the hierarchy to output. Specify 0 or omit it to output all levels below.

Description

Dumps the layer structure

Writes the structure of the layer tree rooted at this layer to the debug log.

releaseTouchCapture¶

Method

Arguments

Arguments	Default	Description
`id`	`void`	The individual touch ID to release. If omitted, all touch captures held by this layer are released.

Description

Releases the touch capture

Releases the touch capture held by this layer.

onClick¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the clicked position.
`y`	` `	The y coordinate (in the layer's display coordinates) of the clicked position.

Description

The layer was clicked

Occurs when the layer is clicked.

See also: Layer.onMouseDown / Layer.onDoubleClick

onDoubleClick¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the double-clicked position.
`y`	` `	The y coordinate (in the layer's display coordinates) of the double-clicked position.

Description

The layer was double-clicked

Occurs when the layer is double-clicked.

See also: Layer.onClick

onMouseDown¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the position where the mouse button was pressed.
`y`	` `	The y coordinate (in the layer's display coordinates) of the position where the mouse button was pressed.
`button`	` `	The mouse button that was pressed. One of the following values. `mbLeft :`The left mouse button was pressed `mbMiddle :`The middle mouse button was pressed `mbRight :`The right mouse button was pressed `mbX1 :`The first side button of the mouse was pressed `mbX2 :`The second side button of the mouse was pressed
`shift`	` `	The state of the modifier keys held down when the mouse button was pressed. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down

Description

A mouse button was pressed

Occurs when a mouse button is pressed.

See also: Layer.onClick

onMouseUp¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the position where the mouse button was released.
`y`	` `	The y coordinate (in the layer's display coordinates) of the position where the mouse button was released.
`button`	` `	The mouse button that was released. One of the following values. `mbLeft :`The left mouse button was released `mbMiddle :`The middle mouse button was released `mbRight :`The right mouse button was released `mbX1 :`The first side button of the mouse was released `mbX2 :`The second side button of the mouse was released
`shift`	` `	The state of the modifier keys held down when the mouse button was released. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down

Description

A mouse button was released

Occurs when a mouse button is released.

onMouseMove¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the position the mouse moved to.
`y`	` `	The y coordinate (in the layer's display coordinates) of the position the mouse moved to.
`shift`	` `	The state of the modifier keys and mouse buttons held down while the mouse was moving. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down `ssLeft :`The left mouse button was held down `ssMiddle :`The middle mouse button was held down `ssRight :`The right mouse button was held down

Description

The mouse moved

Occurs when the mouse moves.

onMouseEnter¶

Event

Description

The mouse entered

Occurs when the mouse enters the layer's area.

See also: Layer.onMouseLeave

onMouseLeave¶

Event

Description

The mouse left

Occurs when the mouse leaves the layer's area.

See also: Layer.onMouseEnter

onMouseWheel¶

Event

Arguments

Arguments	Default	Description
`shift`	` `	The state of the modifier keys and mouse buttons held down while the mouse was moving. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down `ssLeft :`The left mouse button was held down `ssMiddle :`The middle mouse button was held down `ssRight :`The right mouse button was held down
`delta`	` `	The wheel rotation amount. Positive when rotated upward (away from the user), negative when rotated downward (toward the user). The minimum step is normally 120.
`x`	` `	The x coordinate (in the layer's display coordinates) of the position where the wheel was rotated.
`y`	` `	The y coordinate (in the layer's display coordinates) of the position where the wheel was rotated.

Description

The mouse wheel was rotated

Occurs when the mouse wheel is rotated.

Like keyboard events, this event is delivered only to the layer that has the focus.

onKeyDown¶

Event

Arguments

Arguments	Default	Description
`key`	` `	The virtual key code of the pressed key.
`shift`	` `	The state of the modifier keys and mouse buttons held down when the key was pressed. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down `ssLeft :`The left mouse button was held down `ssMiddle :`The middle mouse button was held down `ssRight :`The right mouse button was held down When a key is held down long enough to auto-repeat, the following value is also included. `ssRepeat :`Key repeat occurred
`process`	`true`	When calling the parent class's onKeyDown, passing false for this argument makes the parent class skip its default handling for the key (such as moving the focus).

Description

A key was pressed

Occurs when a key is pressed.

onKeyUp¶

Event

Arguments

Arguments	Default	Description
`key`	` `	The virtual key code of the released key.
`shift`	` `	The state of the modifier keys and mouse buttons held down when the key was released. A bitwise OR combination of the following values. `ssAlt :`The ALT key was held down `ssShift :`The SHIFT key was held down `ssCtrl :`The CTRL key was held down `ssLeft :`The left mouse button was held down `ssMiddle :`The middle mouse button was held down `ssRight :`The right mouse button was held down
`process`	`true`	When calling the parent class's onKeyUp, passing false for this argument makes the parent class skip its default handling for the key (such as moving the focus).

Description

A key was released

Occurs when a key is released.

onKeyPress¶

Event

Arguments

Arguments	Default	Description
`key`	` `	The character that was entered.
`process`	`true`	When calling the parent class's onKeyPress, passing false for this argument makes the parent class skip its default handling for the key (such as moving the focus).

Description

A character was entered

Occurs when a character is entered. Unlike Layer.onKeyDown, which deals with virtual key codes, this event deals with the characters themselves. It does not occur for keys that do not produce characters (function keys, etc.).

onHitTest¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's display coordinates) of the position being tested.
`y`	` `	The y coordinate (in the layer's display coordinates) of the position being tested.
`hit`	` `	True if the point is a hit, false otherwise. Pass the result of the hit test in this argument of the superclass's event of the same name.

Description

Hit test

Called when a hit test is performed for a point within the layer.

Pass the result of the hit test as the third argument of the superclass's version of this event (pass the first and second arguments through unchanged).

If the point is a hit, mouse messages are not passed through and are handled by this layer.

If it is not a hit, mouse messages pass through and are handled by layers further back.

This event is called after the hit test performed by Layer.hitThreshold and Layer.hitType has judged the point to be a hit. Therefore, if Layer.hitThreshold or Layer.hitType judges the point not to be a hit, this event is not called.

onBlur¶

Event

Arguments

Arguments	Default	Description
`focused`	` `	The layer object that newly gained the focus.

Description

Lost the focus

Called when the layer loses the focus.

onFocus¶

Event

Arguments

Arguments	Default	Description
`focused`	` `	The layer object that lost the focus.
`direction`	` `	True when the focus changes by a forward search for the next focusable layer, false when it changes by a backward search.

Description

Gained the focus

Called when the layer gains the focus.

onNodeDisabled¶

Event

Description

The node became disabled

Called when the layer becomes disabled because the Layer.enabled property of the layer itself or of one of its ancestors (in the parent-child tree) has changed.

onNodeEnabled¶

Event

Description

The node became enabled

Called when the layer becomes enabled because the Layer.enabled property of the layer itself or of one of its ancestors (in the parent-child tree) has changed.

onSearchPrevFocusable¶

Event

Arguments

Arguments	Default	Description
`layer`	` `	The layer object that will receive the focus. Pass it as the argument when calling the parent class's method of the same name. Passing null means there is no focusable layer.

Description

Searching backward for a focusable layer

Occurs when searching backward for a focusable layer.

To specify the layer that should receive the focus, pass that layer as the argument of the superclass's event of the same name.

onSearchNextFocusable¶

Event

Arguments

Arguments	Default	Description
`layer`	` `	The layer object that will receive the focus. Pass it as the argument when calling the parent class's method of the same name. Passing null means there is no focusable layer.

Description

Searching forward for a focusable layer

Occurs when searching forward for a focusable layer.

To specify the layer that should receive the focus, pass that layer as the argument of the superclass's event of the same name.

onBeforeFocus¶

Event

Arguments

Arguments	Default	Description
`layer`	` `	The layer object that will receive the focus. Normally this is this, but by specifying a different layer object when calling the superclass's event of the same name, you can pass the focus to that layer instead.
`blurred`	` `	The layer object that will lose the focus.
`direction`	` `	True when the focus changes by a forward search for the next focusable layer, false when it changes by a backward search.

Description

Just before receiving the focus

Occurs just before the layer receives the focus.

To specify the layer that should receive the focus, you can pass that layer as the first argument of the superclass's event of the same name.

onPaint¶

Event

Description

About to be drawn

Called just before the layer is actually drawn to the window.

This event is called only while the Layer.callOnPaint property is true; Layer.callOnPaint is automatically set to false after this event finishes.

See also: Layer.update

onTransitionCompleted¶

Event

Arguments

Arguments	Default	Description
`dest`	` `	The destination layer object of the transition (normally this).
`src`	` `	The source layer object of the transition. Depending on the transition type, this can be null.

Description

A transition finished

Called when a transition finishes.

onTouchDown¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in client coordinates) of the touched position.
`y`	` `	The y coordinate (in client coordinates) of the touched position.
`cx`	` `	The horizontal number of pixels in contact with the finger. Always 1 if the device does not support it.
`cy`	` `	The vertical number of pixels in contact with the finger. Always 1 if the device does not support it.
`id`	` `	The touch ID. During multi-touch, each touch point gets a unique value, which identifies the point.

Description

The screen was touched

Occurs when the touch panel is touched.

This event occurs when the X, Y coordinates are inside this layer.

onTouchUp¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in client coordinates) of the position where the finger was lifted.
`y`	` `	The y coordinate (in client coordinates) of the position where the finger was lifted.
`cx`	` `	The horizontal number of pixels in contact with the finger. Always 1 if the device does not support it.
`cy`	` `	The vertical number of pixels in contact with the finger. Always 1 if the device does not support it.
`id`	` `	The touch ID. During multi-touch, each touch point gets a unique value, which identifies the point.

Description

A finger was lifted from the screen

Occurs when a finger is lifted from the touch panel.

This event occurs when the X, Y coordinates are inside this layer.

Unlike the mouse, however, the target is determined by the current coordinates, so it may not be the same layer that received onTouchDown.

onTouchMove¶

Event

Arguments

Arguments	Default	Description
`x`	` `	The x coordinate (in client coordinates) of the touch position.
`y`	` `	The y coordinate (in client coordinates) of the touch position.
`cx`	` `	The horizontal number of pixels in contact with the finger. Always 1 if the device does not support it.
`cy`	` `	The vertical number of pixels in contact with the finger. Always 1 if the device does not support it.
`id`	` `	The touch ID. During multi-touch, each touch point gets a unique value, which identifies the point.

Description

A finger moved

Occurs when a finger touching the touch panel moves.

This event occurs when the X, Y coordinates are inside this layer.

Unlike the mouse, however, the target is determined by the current coordinates, so it may not be the same layer that received onTouchDown.

onTouchScaling¶

Event

Arguments

Arguments	Default	Description
`startdistance`	` `	The pixel distance when the multi-touch started.
`currentdistance`	` `	The pixel distance of the touches when the event occurred.
`cx`	` `	The x coordinate of the center. Passed in this layer's local coordinates (same as onTouchDown).
`cy`	` `	The y coordinate of the center. Uses the same coordinate system as cx.
`flag`	` `	Multi-touch state flags. `0x01 :`Set on the first event after the multi-touch started.

Description

A pinch-zoom gesture was made

Occurs when a multi-touch zoom (pinch) gesture is made on the touch panel.

This event is delivered to the layer that has the focus.

The distances (startdistance / currentdistance) are pixel distances on the drawing area and are not converted to layer coordinates (compute the zoom factor as the ratio currentdistance / startdistance). Before 2026-09-29, the center (cx / cy) was passed in drawing-area coordinates.

onTouchRotate¶

Event

Arguments

Arguments	Default	Description
`startangle`	` `	The angle in radians when the multi-touch started.
`currentangle`	` `	The angle in radians of the touches when the event occurred.
`distance`	` `	The pixel distance of the touches when the event occurred.
`cx`	` `	The x coordinate of the center. Passed in this layer's local coordinates (same as onTouchDown).
`cy`	` `	The y coordinate of the center. Uses the same coordinate system as cx.
`flag`	` `	Multi-touch state flags. `0x01 :`Set on the first event after the multi-touch started.

Description

A rotate gesture was made

Occurs when a multi-touch rotate gesture is made on the touch panel.

This event is delivered to the layer that has the focus.

onMultiTouch¶

Event

Description

The multi-touch state changed

Occurs when a multi-touch starts, moves, or is released.

The touch coordinates can be obtained with the Window.touchPointCount property and the Window.getTouchPoint method.

This event is delivered to the layer that has the focus.

Plugin extension: krkr_richtext¶

Extends Layer with rich text drawing methods

Members¶

Properties¶

useCache

useCache¶

Property \ Access: r/w

Description

Whether to use the glyph cache

true (default): caches glyphs for speed false: renders every time

drawTextEx¶

Method

Arguments

Arguments	Default	Description
`text`	` `	Text to draw
`x`	` `	X coordinate to start drawing at
`y`	` `	Y coordinate to start drawing at (baseline position)
`style`	` `	RichText.Style object
`appearance`	` `	RichText.Appearance object

Return value

Array of the drawn area [x, y, width, height]

Description

Draws a single line of text

Basic single-line text drawing. No automatic line wrapping is performed.

Note: To avoid a name clash with Kirikiri's standard Layer.drawText(), the name on the TJS side is drawTextEx.

Example: var style = new RichText.Style(); style.setFonts(["MSゴシック"]); style.fontSize = 24;

var app = new RichText.Appearance(); app.addFill(0xFFFFFFFF);

var rect = layer.drawTextEx("Hello World", 10, 50, style, app);

drawParagraph¶

Method

Arguments

Arguments	Default	Description
`text`	` `	Text to draw
`x`	` `	Left edge of the drawing area
`y`	` `	Top edge of the drawing area
`width`	` `	Width of the drawing area
`height`	` `	Height of the drawing area
`hAlign`	` `	Horizontal alignment (RichText.HALIGN_LEFT/CENTER/RIGHT)
`vAlign`	` `	Vertical alignment (RichText.VALIGN_TOP/MIDDLE/BOTTOM)
`style`	` `	RichText.Style object
`appearance`	` `	RichText.Appearance object

Return value

Array of the actual drawn area [x, y, width, height]

Description

Draws a paragraph (multi-line text)

Draws text with automatic line wrapping inside the specified rectangle.

Example: var rect = layer.drawParagraph( "長いテキストは自動的に\n改行されます。", 10, 10, 300, 200, RichText.HALIGN_LEFT, RichText.VALIGN_TOP, style, app );

drawStyledText¶

Method

Arguments

Arguments	Default	Description
`text`	` `	Text with style tags
`x`	` `	Left edge of the drawing area
`y`	` `	Top edge of the drawing area
`width`	` `	Width of the drawing area
`height`	` `	Height of the drawing area
`hAlign`	` `	Horizontal alignment (RichText.HALIGN_LEFT/CENTER/RIGHT)
`vAlign`	` `	Vertical alignment (RichText.VALIGN_TOP/MIDDLE/BOTTOM)
`styles`	` `	A single Style, or a dictionary mapping style names to Styles
`appearances`	` `	A single Appearance, or a dictionary mapping style names to Appearances
`lineSpacing`	`0`	Line spacing (default: 0)

Return value

Array of the actual drawn area [x, y, width, height]

Description

Draws text with style tags

Draws text while switching styles with <style:name> tags. Passing a single object for styles / appearances treats it as the "default" key.

Example:

// Draw with a single style
layer.drawStyledText(
"テキスト",
10, 10, 400, 300,
RichText.HALIGN_LEFT, RichText.VALIGN_TOP,
style, app
);

// Draw with multiple styles
var styles = %[ "default": normalStyle, "bold": boldStyle ];
var apps = %[ "default": normalApp, "bold": boldApp ];
layer.drawStyledText(
"通常<style:bold>太字</style>通常",
10, 10, 400, 300,
RichText.HALIGN_LEFT, RichText.VALIGN_TOP,
styles, apps
);

drawTextLayout¶

Method

Arguments

Arguments	Default	Description
`textLayout`	` `	RichText.Layout object (after layout())
`x`	` `	X coordinate to start drawing at
`y`	` `	Y coordinate to start drawing at (baseline position)
`appearance`	` `	RichText.Appearance object
`maxChars`	`-1`	Maximum number of characters to draw (-1 for all; default: -1)

Return value

Array of the drawn area [x, y, width, height]

Description

Draws a laid-out TextLayout

Draws a Layout whose layout has been computed in advance. Useful for redrawing the same layout.

Example: var tl = new RichText.Layout(); tl.layout("Hello World", style); layer.drawTextLayout(tl, 10, 50, appearance);

drawParagraphLayout¶

Method

Arguments

Arguments	Default	Description
`paraLayout`	` `	RichText.ParagraphLayout object (after layout())
`x`	` `	Left edge of the drawing area
`y`	` `	Top edge of the drawing area
`width`	` `	Width of the drawing area
`height`	` `	Height of the drawing area
`hAlign`	` `	Horizontal alignment (RichText.HALIGN_LEFT/CENTER/RIGHT)
`vAlign`	` `	Vertical alignment (RichText.VALIGN_TOP/MIDDLE/BOTTOM)
`style`	` `	RichText.Style object
`appearance`	` `	RichText.Appearance object
`maxChars`	`-1`	Maximum number of characters to draw (-1 for all; default: -1)

Return value

Array of the actual drawn area [x, y, width, height]

Description

Draws a laid-out ParagraphLayout

Draws a ParagraphLayout whose layout has been computed in advance. Specifying maxChars enables progressive (character-by-character) display.

Example: var pl = new RichText.ParagraphLayout(); pl.layout("長いテキスト...", 300, style);

layer.drawParagraphLayout(pl, 10, 10, 300, 200, RichText.HALIGN_LEFT, RichText.VALIGN_TOP, style, app);

// Character-by-character display (draw only the first 5 characters) layer.drawParagraphLayout(pl, 10, 10, 300, 200, RichText.HALIGN_LEFT, RichText.VALIGN_TOP, style, app, 5);

drawStyledLayout¶

Method

Arguments

Arguments	Default	Description
`styledLayout`	` `	RichText.StyledLayout object
`x`	` `	X coordinate to draw at
`y`	` `	Y coordinate to draw at
`maxChars`	`-1`	Maximum number of characters to draw (-1 for all; default: -1)

Return value

Array of the actual drawn area [x, y, width, height]

Description

Draws a laid-out StyledLayout

Draws a StyledLayout whose layout has been computed in advance. Specifying maxChars enables a character-by-character animation.

Example: var sl = new RichText.StyledLayout(); sl.layout(text, 400, 300, RichText.HALIGN_LEFT, RichText.VALIGN_TOP, style, app);

// Draw everything layer.drawStyledLayout(sl, 10, 10);

// Character-by-character display (draw only the first 5 characters) layer.drawStyledLayout(sl, 10, 10, 5);

drawRectEx¶

Method

Arguments

Arguments	Default	Description
`x`	` `	X coordinate
`y`	` `	Y coordinate
`width`	` `	Width
`height`	` `	Height
`fillColor`	`0`	Fill color (ARGB; default: 0)
`strokeColor`	`0`	Stroke color (ARGB; 0 disables; default: 0)
`strokeWidth`	`0`	Stroke width (default: 0)

Description

Draws a rectangle

Note: To avoid a name clash with Kirikiri's standard Layer.drawRect(), the name on the TJS side is drawRectEx.

Example: layer.drawRectEx(10, 10, 200, 100, 0x80FF0000); // semi-transparent red rectangle layer.drawRectEx(10, 10, 200, 100, 0, 0xFF000000, 2); // black outline only

clearCache¶

Method

Description

Clears the cache

setCacheMaxSize¶

Method

Arguments

Arguments	Default	Description
`bytes`	` `	Maximum number of bytes

Description

Sets the maximum cache size

Plugin extension: layerExAreaAverage¶

Extends Layer with methods that draw images reduced using the area-average method

Members¶

Plugin extension: layerExBTOA¶

Manual written as pseudocode

Members¶

Methods¶

copyRightBlueToLeftAlpha
copyBottomBlueToTopAlpha
fillAlpha
copyAlphaToProvince
clipAlphaRect
overwrapRect
fillByProvince
fillToProvince

copyRightBlueToLeftAlpha¶

Method

Description

Copies the blue channel of the right half of the layer to the alpha channel of the left half

Clipping is not supported

copyBottomBlueToTopAlpha¶

Method

Description

Copies the blue channel of the bottom half of the layer to the alpha channel of the top half

Clipping is not supported

fillAlpha¶

Method

Description

Fills the layer's alpha channel with 0xff

copyAlphaToProvince¶

Method

Arguments

Arguments	Default	Description
`threshold`	` `	Threshold. If omitted or void, the alpha is copied as is. If a number is given, pixels whose alpha is at or above the threshold are filled with matched, and the others with otherwise
`matched`	`1`	Value to fill with where the alpha is at or above the threshold, when threshold is given. A value outside 0-255 leaves those pixels unfilled
`otherwise`	`0`	Value to fill with where the alpha is below the threshold, when threshold is given. A value outside 0-255 leaves those pixels unfilled

Description

Copies the layer's alpha channel to the province image

clipAlphaRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Left edge
`dtop`	` `	Top edge
`src`	` `	Source image with the alpha to multiply by
`sleft`	` `	Left edge of the source
`stop`	` `	Top edge of the source
`swidth`	` `	Width of the source
`sheight`	` `	Height of the source
`clear`	` `	Fills the area outside the operated range with this value (opacity). If omitted or not in 0-255, the area is not filled

Description

Multiplies the layer's alpha channel by the alpha channel of src

overwrapRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Left edge
`dtop`	` `	Top edge
`src`	` `	Source image with the alpha to multiply by
`sleft`	` `	Left edge of the source
`stop`	` `	Top edge of the source
`swidth`	` `	Width of the source
`sheight`	` `	Height of the source
`threshold`	`1`	Threshold

Description

Overlays src on the layer (excluding pixels where src's alpha channel is below the threshold) / provided because operateRect's omAlpha can produce incorrect values when SSE is used

fillByProvince¶

Method

Arguments

Arguments	Default	Description
`index`	` `	Province image index value (0 to 255)
`color`	` `	Fill color (0xAARRGGBB)

Description

Fills the areas where the province image has the specified value with the specified color

fillToProvince¶

Method

Arguments

Arguments	Default	Description
`color`	` `	Color to match (0xRRGGBB)
`index`	` `	Province image index value (0 to 255)
`threshold`	`64`	Alpha threshold (0-255; pixels at or above the value match)

Description

Fills the province image with the specified index at pixels matching a given color

Plugin extension: layerExDraw¶

Extends Layer with vector drawing methods

Drawing is clipped to the clipping area set on the layer.

Members¶

Properties¶

updateWhenDraw
smoothingMode
textRenderingHint
record

Methods¶

setTransform
resetTransform
rotateTransform
scaleTransform
translateTransform
setResolution
clear
drawPath
drawArc
drawPie
drawBezier
drawBeziers
drawClosedCurve
drawClosedCurve2
drawCurve
drawCurve2
drawCurve3
drawEllipse
drawLine
drawLines
drawPolygon
drawRectangle
drawRectangles
drawPathString
drawString
measureString
measureStringInternal
drawImage
drawImageRect
drawImageStretch
drawImageAffine
setViewTransform
resetViewTransform
rotateViewTransform
scaleViewTransform
translateViewTransform
saveRecord
loadRecord
getRecordImage
saveImage
getColorRegionRects

Constants¶

EncoderValueCompressionLZW
EncoderValueCompressionCCITT3
EncoderValueCompressionCCITT4
EncoderValueCompressionRle
EncoderValueCompressionNone
EncoderValueScanMethodInterlaced
EncoderValueScanMethodNonInterlaced
EncoderValueVersionGif87
EncoderValueVersionGif89
EncoderValueRenderProgressive
EncoderValueRenderNonProgressive
EncoderValueTransformRotate90
EncoderValueTransformRotate180
EncoderValueTransformRotate270
EncoderValueTransformFlipHorizontal
EncoderValueTransformFlipVertical

updateWhenDraw¶

Property \ Access: r/w

Description

Whether to call update() for the drawn area when drawing

smoothingMode¶

Property \ Access: r/w

Description

Antialiasing setting for drawing (SmoothingMode)

Default: SmoothingModeAntiAlias

textRenderingHint¶

Property \ Access: r/w

Description

Rendering setting for text drawing (TextRenderingHint)

Default: TextRenderingHintAntiAlias

record¶

Property \ Access: r/w

Description

Whether to record what this plugin draws

While record = true, specifying viewTransform redraws the recorded drawing as is.

setTransform¶

Method

Arguments

Arguments	Default	Description
`matrix`	` `

Description

Sets the transform used for drawing

resetTransform¶

Method

rotateTransform¶

Method

Arguments

Arguments	Default	Description
`angle`	` `

scaleTransform¶

Method

Arguments

Arguments	Default	Description
`sx`	` `
`sy`	` `

translateTransform¶

Method

Arguments

Arguments	Default	Description
`dx`	` `
`dy`	` `

setResolution¶

Method

Arguments

Arguments	Default	Description
`resx`	` `	Horizontal resolution, in percent
`resy`	` `	Vertical resolution, in percent

Description

Sets the resolution

clear¶

Method

Arguments

Arguments	Default	Description
`argb`	` `	Clear color

Description

Clears the image

drawPath¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`path`	` `	Path: specifies a GdiPlus.Path

Return value

Dictionary with the updated area: left, top, width, height

Description

Draws a path

drawArc¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Top-left coordinate
`y`	` `	Top-left coordinate
`width`	` `	Width
`height`	` `	Height
`startAngle`	` `	Start angle of the arc, clockwise
`sweepAngle`	` `	Sweep angle

Return value

Dictionary with the updated area: left, top, width, height

Description

Draws an arc

drawPie¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Top-left coordinate
`y`	` `	Top-left coordinate
`width`	` `	Width
`height`	` `	Height
`startAngle`	` `	Start angle of the arc, clockwise
`sweepAngle`	` `	Sweep angle

Return value

Updated area information (RectF)

Description

Draws a pie (sector)

drawBezier¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x1`	` `
`y1`	` `
`x2`	` `
`y2`	` `
`x3`	` `
`y3`	` `
`x4`	` `
`y4`	` `

Return value

Updated area information (RectF)

Description

Draws a Bézier curve

drawBeziers¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws connected Bézier curves

drawClosedCurve¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a closed cardinal spline

drawClosedCurve2¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a closed cardinal spline

drawCurve¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawCurve2¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawCurve3¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`offset`	` `
`numberOfSegments`	` `
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawEllipse¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `
`y`	` `
`width`	` `
`height`	` `

Return value

Updated area information (RectF)

Description

Draws an ellipse

drawLine¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x1`	` `	X coordinate of the start point
`y1`	` `	Y coordinate of the start point
`x2`	` `	X coordinate of the end point
`y2`	` `	Y coordinate of the end point

Return value

Updated area information (RectF)

Description

Draws a line segment

drawLines¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws connected line segments

drawPolygon¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a polygon

drawRectangle¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `
`y`	` `
`width`	` `
`height`	` `

Return value

Updated area information (RectF)

Description

Draws a rectangle

drawRectangles¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`rects`	` `	Array of rectangles [ [x1, y1, width1, height1], [x2, y2, width2, height2] .... ]

Return value

Updated area information (RectF)

Description

Draws multiple rectangles

drawPathString¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font: specifies the font with a GdiPlus.Font
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Drawing position X
`y`	` `	Drawing position Y
`text`	` `	Text to draw

Return value

Updated area information (RectF)

Description

Draws a string as paths

drawString¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font: specifies the font with a GdiPlus.Font
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance. * Only the brush is used
`x`	` `	Drawing position X
`y`	` `	Drawing position Y
`text`	` `	Text to draw

Return value

Updated area information (RectF)

Description

Draws a string. The drawing quality follows textRenderingHint.

measureString¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font
`text`	` `	Text to draw

Return value

Drawing area information (RectF)

Description

Gets the drawing area of a string. The drawing quality follows textRenderingHint

measureStringInternal¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font
`text`	` `	Text to draw

Return value

Drawing area information (RectF)

Description

Gets the drawing area of a string. Returns the rectangle where the string actually exists, excluding the margins, within the area obtained with measureString().

drawImage¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `
`dtop`	` `
`src`	` `

Return value

Updated area information (RectF)

Description

Draws an image. The destination position takes the source image's Bounds into account, and the size is in pixels.

drawImageRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Destination left edge
`dtop`	` `	Destination top edge
`src`	` `	Source image (Image/Layer/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle

Return value

Updated area information (RectF)

Description

Copies a rectangle of an image

drawImageStretch¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Destination left edge
`dtop`	` `	Destination top edge
`dwidth`	` `	Destination width
`dheight`	` `	Destination height
`src`	` `	Source image (Image/Layer/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle

Return value

Updated area information (RectF)

Description

Copies an image with scaling

drawImageAffine¶

Method

Arguments

Arguments	Default	Description
`src`	` `	Source image (Image/Layer/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle
`affine`	` `	Kind of affine parameters (true: transformation matrix, false: coordinates),
`A`	` `
`B`	` `
`C`	` `
`D`	` `
`E`	` `
`F`	` `

Return value

Updated area information (RectF)

Description

Copies an image with an affine transformation

setViewTransform¶

Method

Arguments

Arguments	Default	Description
`matrix`	` `

Description

Sets the transform used to display the recorded content

resetViewTransform¶

Method

rotateViewTransform¶

Method

Arguments

Arguments	Default	Description
`angle`	` `

scaleViewTransform¶

Method

Arguments

Arguments	Default	Description
`sx`	` `
`sy`	` `

translateViewTransform¶

Method

Arguments

Arguments	Default	Description
`dx`	` `
`dy`	` `

saveRecord¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name to save to

Return value

true on success

Description

Saves the recorded content

loadRecord¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name to load from

Return value

true on success

Description

Loads recorded content

getRecordImage¶

Method

Description

Returns the recorded content as an Image

return Image object

saveImage¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name
`mime`	` `	Image format to save in: image/jpeg, image/png, image/gif, etc.
`param`	`void`	Encoding parameters (dictionary) compression, scanmethod, version, render, transform, quality (0 to 100), depth (1, 4, 8, 24, 32)

Description

Saves the image

getColorRegionRects¶

Method

Arguments

Arguments	Default	Description
`color`	` `	Color

Return value

Array of rectangles

Description

Returns the region containing the areas of the specified color

EncoderValueCompressionLZW¶

Constant

Description

For compression

EncoderValueCompressionCCITT3¶

Constant

EncoderValueCompressionCCITT4¶

Constant

EncoderValueCompressionRle¶

Constant

EncoderValueCompressionNone¶

Constant

EncoderValueScanMethodInterlaced¶

Constant

Description

For scanmethod

EncoderValueScanMethodNonInterlaced¶

Constant

EncoderValueVersionGif87¶

Constant

Description

For version

EncoderValueVersionGif89¶

Constant

EncoderValueRenderProgressive¶

Constant

Description

For render

EncoderValueRenderNonProgressive¶

Constant

EncoderValueTransformRotate90¶

Constant

Description

For transform

EncoderValueTransformRotate180¶

Constant

EncoderValueTransformRotate270¶

Constant

EncoderValueTransformFlipHorizontal¶

Constant

EncoderValueTransformFlipVertical¶

Constant

Plugin extension: layerExImage¶

Members¶

Methods¶

light
colorize
modulate
noise
generateWhiteNoise

light¶

Method

Arguments

Arguments	Default	Description
`brightness`	` `	Brightness -255 to 255; negative values darken
`contrast`	` `	Contrast -100 to 100; 0 means no change

Description

Brightness and contrast

colorize¶

Method

Arguments

Arguments	Default	Description
`hue`	` `	Hue
`sat`	` `	Saturation
`blend`	` `	Blend 0 (no effect) to 1 (full effect)

Description

Hue and saturation

modulate¶

Method

Arguments

Arguments	Default	Description
`hue`	` `	Hue -180 to 180 (degrees)
`saturation`	` `	Saturation -100 to 100 (%)
`luminance`	` `	Luminance -100 to 100 (%)

Description

Changes hue, saturation, and luminance

noise¶

Method

Arguments

Arguments	Default	Description
`level`	` `	Noise level 0 (no noise) to 255 (lot of noise).

Description

Adds noise

generateWhiteNoise¶

Method

Description

Generates noise (draws grayscale white noise, ignoring the original image; alpha information is kept)

Plugin extension: layerExLongExposure¶

Layer extension

Members¶

Methods¶

initExposure
snapExposure
statExposure
copyExposure
termExposure

initExposure¶

Method

Description

Initializes

Initializes the accumulation buffer with the current layer size

snapExposure¶

Method

Description

Adds the current image to the accumulation buffer

The image size must be the same as at init (otherwise an exception is thrown)

statExposure¶

Method

Return value

%[ min_r, max_r, min_g, max_g, min_b, max_b, min_a, max_a ];

Description

Gets the maximum / minimum values of the accumulation buffer

copyExposure¶

Method

Arguments

Arguments	Default	Description
`stat`	` `	: Dictionary of information for clipping the range; if void, statExposure is run implicitly and its values are used. The layer itself is rewritten as an image in which min to max of each component maps to 0 to 255. For any component where min >= max, 0xFF is always returned

Description

Creates an image from the accumulation buffer

termExposure¶

Method

Description

Discards the accumulation buffer

Discards the allocated buffer. It is also discarded automatically on invalidate

Plugin extension: layerExRaster¶

Extends Layer with a raster-effect-style copy drawing method

Members¶

Methods¶

copyRaster

copyRaster¶

Method

Arguments

Arguments	Default	Description
`src`	` `	Source layer. Nothing is done unless it is the same size as this layer.
`maxh`	` `	Maximum amplitude (pixels)
`lines`	` `
`cycle`	` `	Period (msec)
`time`	` `	Current time

Description

Raster copy

Plugin extension: layerExSave¶

Layer extension

Members¶

Methods¶

saveLayerImageTlg5
saveLayerImagePng
saveLayerImagePngOctet
saveProvinceImage
getCropRect
getCropRectZero
getDiffRect
getDiffPixel
oozeColor
copyBlueToAlpha
isBlank
clearAlpha
getAverageColor
getFingerPrintValue
getShrinkVectorOctet

saveLayerImageTlg5¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name
`tags`	`void`	Tag information

Description

Saves the image in TLG5 format. Note: the call does not return until the data has been saved.

saveLayerImagePng¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name
`tags`	`void`	Dictionary describing the tag information and the compression level (comp_lv)

Description

Saves the image in PNG format. Note: the call does not return until the data has been saved.

saveLayerImagePngOctet¶

Method

Arguments

Arguments	Default	Description
`compression_level_or_tags`	`1`	Compression level or tag information dictionary (default 1)

Description

Returns a PNG image as an octet. Note: the call does not return until the data has been saved.

The tag information dictionary has the same format as for saveLayerImagePng (the compression level can be specified with comp_lv)

saveProvinceImage¶

Method

Arguments

Arguments	Default	Description
`filename`	` `	File name
`palette`	`void`	Palette information (* reserved for future use / currently not implemented)

Description

Saves the province image (format: fixed 256-color palette PNG) * Only available in LodePNG implementation mode

An exception is thrown if there is no province image (e.g. for a layer that has never been drawn to with dfProvince)

getCropRect¶

Method

Return value

Dictionary of the form %[ x, y, w, h], or void (when everything is transparent)

Description

Gets the size the layer image would have if cropped (trimming the transparent margins on the top, bottom, left, and right).

getCropRectZero¶

Method

Return value

Dictionary of the form %[ x, y, w, h], or void (when everything is transparent)

Description

Gets the size the layer image would have if cropped (trimming the fully transparent (0x00000000) parts on the top, bottom, left, and right).

getDiffRect¶

Method

Arguments

Arguments	Default	Description
`base`	` `	Base image to compare against

Return value

Dictionary of the form %[ x, y, w, h ], or void (when the images are exactly the same) (an exception is thrown unless base is the same size as this instance)

Description

Gets the area that differs between layers.

getDiffPixel¶

Method

Arguments

Arguments	Default	Description
`base`	` `	Base image to compare against
`samecol`	` `	Color to fill matching pixels with (0xAARRGGBB) (void or omitted: no fill)
`diffcol`	` `	Color to fill differing pixels with (0xAARRGGBB) (void or omitted: no fill) @description (an exception is thrown unless base is the same size as this instance)

Description

Compares the layers pixel by pixel.

oozeColor¶

Method

Arguments

Arguments	Default	Description
`level`	` `	Number of passes. The larger it is, the wider the extended area
`threshold`	`1`	Alpha threshold (1 to 255); colors are extended into pixels below it
`fillColor`	`0`	Fill color outside the processed area (0xRRGGBB)

Description

Extends the colors at the layer's edges into the transparent areas (prevents false colors when reducing)

copyBlueToAlpha¶

Method

Arguments

Arguments	Default	Description
`src`	` `	Source layer

Description

Copies the layer's blue channel to the alpha channel

isBlank¶

Method

Arguments

Arguments	Default	Description
`x`	` `
`y`	` `
`w`	` `
`h`	` `

Return value

true if blank

Description

Checks whether the specified area of the layer is blank

clearAlpha¶

Method

Arguments

Arguments	Default	Description
`threshold`	`0`	Alpha threshold. Pixels whose alpha is at or below this value are filled
`fillColor`	`0`	Fill color (0x00RRGGBB)

Description

Fills the parts whose alpha is at or below the given value with the specified color

getAverageColor¶

Method

Arguments

Arguments	Default	Description
`left`	` `
`top`	` `
`width`	` `
`height`	` `

Description

Returns the average color of the specified area of the layer

getFingerPrintValue¶

Method

Arguments

Arguments	Default	Description
`ignore_transparent`	`true`	: Ignores the RGB values of fully transparent pixels

Return value

64-bit hash value

Description

Returns a hash value of the layer's dfMain image

The hash also takes imageWidth/Height into account. Even when the values are equal, compare strictly using getDiffPixel or the like

getShrinkVectorOctet¶

Method

Arguments

Arguments	Default	Description
`w`	`16`
`h`	`16`

Return value

Vector octet

Description

Returns a reduced vector octet of the layer image

Plugin extension: layerExVector¶

Extends Layer with vector drawing methods

Drawing is clipped to the clipping area set on the layer.

Members¶

Properties¶

updateWhenDraw
smoothingMode

Methods¶

setViewTransform
resetViewTransform
rotateViewTransform
scaleViewTransform
translateViewTransform
setTransform
resetTransform
rotateTransform
scaleTransform
translateTransform
clear
drawPath
drawArc
drawPie
drawBezier
drawBeziers
drawClosedCurve
drawClosedCurve2
drawCurve
drawCurve2
drawCurve3
drawEllipse
drawLine
drawLines
drawPolygon
drawRectangle
drawRectangles
drawString
drawStringArea
drawImage
drawImageRect
drawImageStretch
drawImageAffine

updateWhenDraw¶

Property \ Access: r/w

Description

Whether to call update() for the drawn area when drawing

smoothingMode¶

Property \ Access: r/w

Description

Antialiasing setting for drawing (kept for compatibility)

setViewTransform¶

Method

Arguments

Arguments	Default	Description
`matrix`	` `

Description

Sets the view transform

resetViewTransform¶

Method

rotateViewTransform¶

Method

Arguments

Arguments	Default	Description
`angle`	` `

scaleViewTransform¶

Method

Arguments

Arguments	Default	Description
`sx`	` `
`sy`	` `

translateViewTransform¶

Method

Arguments

Arguments	Default	Description
`dx`	` `
`dy`	` `

setTransform¶

Method

Arguments

Arguments	Default	Description
`matrix`	` `

Description

Sets the transform used for drawing

resetTransform¶

Method

rotateTransform¶

Method

Arguments

Arguments	Default	Description
`angle`	` `

scaleTransform¶

Method

Arguments

Arguments	Default	Description
`sx`	` `
`sy`	` `

translateTransform¶

Method

Arguments

Arguments	Default	Description
`dx`	` `
`dy`	` `

clear¶

Method

Arguments

Arguments	Default	Description
`argb`	` `	Clear color

Description

Clears the image

drawPath¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`path`	` `	Path: specifies a GdiPlus.Path

Return value

Updated area information (RectF)

Description

Draws a path

drawArc¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Top-left coordinate
`y`	` `	Top-left coordinate
`width`	` `	Width
`height`	` `	Height
`startAngle`	` `	Start angle of the arc, clockwise
`sweepAngle`	` `	Sweep angle

Return value

Updated area information (RectF)

Description

Draws an arc

drawPie¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Top-left coordinate
`y`	` `	Top-left coordinate
`width`	` `	Width
`height`	` `	Height
`startAngle`	` `	Start angle of the arc, clockwise
`sweepAngle`	` `	Sweep angle

Return value

Updated area information (RectF)

Description

Draws a pie (sector)

drawBezier¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x1`	` `
`y1`	` `
`x2`	` `
`y2`	` `
`x3`	` `
`y3`	` `
`x4`	` `
`y4`	` `

Return value

Updated area information (RectF)

Description

Draws a Bézier curve

drawBeziers¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws connected Bézier curves

drawClosedCurve¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a closed cardinal spline

drawClosedCurve2¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a closed cardinal spline

drawCurve¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawCurve2¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawCurve3¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]
`offset`	` `
`numberOfSegments`	` `
`tension`	` `	Tension

Return value

Updated area information (RectF)

Description

Draws a cardinal spline

drawEllipse¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `
`y`	` `
`width`	` `
`height`	` `

Return value

Updated area information (RectF)

Description

Draws an ellipse

drawLine¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x1`	` `	X coordinate of the start point
`y1`	` `	Y coordinate of the start point
`x2`	` `	X coordinate of the end point
`y2`	` `	Y coordinate of the end point

Return value

Updated area information (RectF)

Description

Draws a line segment

drawLines¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws connected line segments

drawPolygon¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`points`	` `	Array of points [ [x1, y1], [x2, y2] .... ]

Return value

Updated area information (RectF)

Description

Draws a polygon

drawRectangle¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `
`y`	` `
`width`	` `
`height`	` `

Return value

Updated area information (RectF)

Description

Draws a rectangle

drawRectangles¶

Method

Arguments

Arguments	Default	Description
`app`	` `	Appearance
`rects`	` `	Array of rectangles [ [x1, y1, width1, height1], [x2, y2, width2, height2] .... ]

Return value

Updated area information (RectF)

Description

Draws multiple rectangles

drawString¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font: specifies the font with a GdiPlus.Font
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Drawing position X
`y`	` `	Drawing position Y
`text`	` `	Text to draw

Return value

Updated area information (RectF)

Description

Draws a string

drawStringArea¶

Method

Arguments

Arguments	Default	Description
`font`	` `	Font: specifies the font with a GdiPlus.Font
`app`	` `	Appearance: specifies the drawing style with a GdiPlus.Appearance
`x`	` `	Left edge of the rectangle
`y`	` `	Top edge of the rectangle
`w`	` `	Width of the rectangle
`h`	` `	Height of the rectangle
`alignX`	` `	Horizontal alignment (0 = left, 0.5 = center, 1 = right)
`alignY`	` `	Vertical alignment (0 = top, 0.5 = center, 1 = bottom)
`wrap`	` `	Word wrap mode (0=None, 1=Char, 2=Word, 3=MixedWrap, 4=Ellipsis)
`text`	` `	Text to draw

Return value

Updated area information (RectF)

Description

Draws a string inside a rectangle

drawImage¶

Method

Arguments

Arguments	Default	Description
`x`	` `	Destination origin X
`y`	` `	Destination origin Y
`image`	` `	Source image (Image/file name)

Return value

Updated area information (RectF)

Description

Draws an image. The destination position takes the source image's Bounds into account, and the size is in pixels.

drawImageRect¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Destination left edge
`dtop`	` `	Destination top edge
`src`	` `	Source image (Image/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle

Return value

Updated area information (RectF)

Description

Copies a rectangle of an image

drawImageStretch¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Destination left edge
`dtop`	` `	Destination top edge
`dwidth`	` `	Destination width
`dheight`	` `	Destination height
`src`	` `	Source image (Image/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle

Return value

Updated area information (RectF)

Description

Copies an image with scaling

drawImageAffine¶

Method

Arguments

Arguments	Default	Description
`src`	` `	Source image (Image/file name)
`sleft`	` `	Left edge of the source rectangle
`stop`	` `	Top edge of the source rectangle
`swidth`	` `	Width of the source rectangle
`sheight`	` `	Height of the source rectangle
`affine`	` `	Kind of affine parameters (true: transformation matrix, false: coordinates)
`A`	` `
`B`	` `
`C`	` `
`D`	` `
`E`	` `
`F`	` `

Return value

Updated area information (RectF)

Description

Copies an image with an affine transformation

Plugin extension: shrinkCopy¶

Members¶

Methods¶

shrinkCopy
shrinkCopyFast

shrinkCopy¶

Method

Arguments

Arguments	Default	Description
`dleft`	` `	Left edge of the destination rectangle. Fractional values allowed.
`dtop`	` `	Top edge of the destination rectangle. Fractional values allowed.
`dwidth`	` `	Width of the destination rectangle. Fractional values allowed.
`dheight`	` `	Height of the destination rectangle. Fractional values allowed.
`src`	` `	Source layer
`sleft`	` `	Left edge of the source rectangle, in pixels. Fractional values not allowed.
`stop`	` `	Top edge of the source rectangle, in pixels. Fractional values not allowed.
`swidth`	` `	Width of the source rectangle, in pixels. Fractional values not allowed.
`sheight`	` `	Height of the source rectangle, in pixels. Fractional values not allowed.

Description

Copies with reduction

An error occurs if the image would be enlarged (dwidth > swidth || dheight > sheight). The reduction algorithm is the area-average method. For reductions to 1/2 or less, quality is higher than affineCopy. Unlike stretchCopy, Layer.face and holdAlpha are ignored.

False colors (colors hidden behind fully transparent areas) can appear at the boundary between transparent and opaque areas, so it is recommended to apply Layer.oozeColor() from layerExSave.dll or similar beforehand

shrinkCopyFast¶

Method

Arguments

Arguments	Default	Description
`src`	` `
`shrink_x`	` `	Horizontal reduction factor (1 or greater)
`shrink_y`	` `	Vertical reduction factor (1 or greater). If omitted or 0, the value of shrink_x is used

Description

Limited reduction copy (reduces by integer fractions and ignores the alpha component)

Transparent parts are ignored and the result is always opaque. When the size is not evenly divisible, the remainder in the rightmost / bottom 1-dot strip may look stretched.

Note that this layer's own size is forcibly changed ⇒ equivalent to setImageSize(Math.ceil(src.imageWidth / shrink_x), Math.ceil(src.imageHeight / shrink_y))

Plugin extension: tftSave¶

Layer extension

Members¶

Methods¶

drawGlyph
renderGlyph
setGlyphInfo

drawGlyph¶

Method

Arguments

Arguments	Default	Description
`ch`	` `	Character code

Description

Draws a character for System.savePreRenderedFont

Updates the PreRenderedFontImage properties of this object. * Note that Kirikiri Z has a function with the same name

renderGlyph¶

Method

Arguments

Arguments	Default	Description
`ch`	` `	Character code

Return value

true on success

Description

DirectWrite version of drawGlyph (experimental)

Draws a glyph with DirectWrite (may fail)

setGlyphInfo¶

Method

Arguments

Arguments	Default	Description
`ch`	` `	Character code

Description

Sets glyph information

Updates only the PreRenderedFontImage properties of this object (a function that does not draw the glyph image of drawGlyph)

Arguments	Default	Description
`window`	` `	The window (an object of the Window class) that will own this layer. Once set, the window cannot be changed.
`parent`	` `	The layer to become the parent of this layer. Specify null to create a primary layer. A window can have only one primary layer, and when layers are used there must always be exactly one; it is the layer that is the parent of all other layers. However, some draw devices (configurable with Window.drawDevice) allow a window to have multiple primary layers. The parent of a layer can be changed with the Layer.parent property.

Arguments	Default	Description
`image`	` `	The image storage to load. If an image storage exists whose name is this storage name (without the extension) followed by _m, it is loaded as the mask (opacity) image. If an image storage exists whose name is this storage name (without the extension) followed by _p, it is loaded as the province image.
`colorkey`	`clNone`	The color key (transparent color) of the image to load. Specifying a color in 0xRRGGBB format makes that color the color key. Specifying `clPalIdx` plus a palette index makes that palette index transparent (for images with 256 colors or fewer). Specifying `clAdapt` automatically makes the color used most often in the top line of the image transparent. Specifying `clAlphaMat` plus a color value in 0xRRGGBB format composites the image onto that color using alpha blending (the ltAlpha method). For example, specifying (clAlphaMat + 0xffffff) composites the loaded image onto white. The result is a fully opaque image (note that although the image becomes fully opaque, the tag information is not changed at all in this mode).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the color from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the color from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the color at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the color at.
`color`	` `	The color to set, in 0xRRGGBB format.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`y`	` `	The y coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`exclude_self`	`false`	Whether to exclude this layer itself from the search. If false, this layer is included in the search. If true, this layer is excluded from the search and treated as if it did not exist. If omitted, false is assumed.
`get_disabled`	`false`	Whether to return disabled layer objects. If false and the layer at the position is disabled (e.g. its Layer.enabled property is false), null is returned. If true and the layer at the position is disabled, that layer object is returned. If omitted, false is assumed.

Arguments	Default	Description
`left`	` `	The left edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.left property.
`top`	` `	The top edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.top property.
`width`	`void`	The width of the layer, in pixels. This value can also be read and set with the Layer.width property. If this argument and the height argument are omitted, only the position is changed using the left and top arguments.
`height`	`void`	The height of the layer, in pixels. This value can also be read and set with the Layer.height property. If this argument and the width argument are omitted, only the position is changed using the left and top arguments.

Arguments	Default	Description
`window`	` `	The window (an object of the Window class) that will own this layer. Once set, the window cannot be changed.
`parent`	` `	The layer to become the parent of this layer. Specify null to create a primary layer. A window can have only one primary layer, and when layers are used there must always be exactly one; it is the layer that is the parent of all other layers. However, some draw devices (configurable with Window.drawDevice) allow a window to have multiple primary layers. The parent of a layer can be changed with the Layer.parent property.

Arguments	Default	Description
`image`	` `	The image storage to load. If an image storage exists whose name is this storage name (without the extension) followed by _m, it is loaded as the mask (opacity) image. If an image storage exists whose name is this storage name (without the extension) followed by _p, it is loaded as the province image.
`colorkey`	`clNone`	The color key (transparent color) of the image to load. Specifying a color in 0xRRGGBB format makes that color the color key. Specifying `clPalIdx` plus a palette index makes that palette index transparent (for images with 256 colors or fewer). Specifying `clAdapt` automatically makes the color used most often in the top line of the image transparent. Specifying `clAlphaMat` plus a color value in 0xRRGGBB format composites the image onto that color using alpha blending (the ltAlpha method). For example, specifying (clAlphaMat + 0xffffff) composites the loaded image onto white. The result is a fully opaque image (note that although the image becomes fully opaque, the tag information is not changed at all in this mode).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the color from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the color from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the color at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the color at.
`color`	` `	The color to set, in 0xRRGGBB format.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`y`	` `	The y coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`exclude_self`	`false`	Whether to exclude this layer itself from the search. If false, this layer is included in the search. If true, this layer is excluded from the search and treated as if it did not exist. If omitted, false is assumed.
`get_disabled`	`false`	Whether to return disabled layer objects. If false and the layer at the position is disabled (e.g. its Layer.enabled property is false), null is returned. If true and the layer at the position is disabled, that layer object is returned. If omitted, false is assumed.

Arguments	Default	Description
`left`	` `	The left edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.left property.
`top`	` `	The top edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.top property.
`width`	`void`	The width of the layer, in pixels. This value can also be read and set with the Layer.width property. If this argument and the height argument are omitted, only the position is changed using the left and top arguments.
`height`	`void`	The height of the layer, in pixels. This value can also be read and set with the Layer.height property. If this argument and the width argument are omitted, only the position is changed using the left and top arguments.

Layer¶

Members for screen readers¶

Members¶

Constructors¶

Properties¶

Methods¶

Events¶

Layer¶

parent¶

children¶

order¶

absolute¶

absoluteOrderMode¶

visible¶

cached¶

nodeVisible¶

neutralColor¶

hasImage¶

opacity¶

window¶

isPrimary¶

left¶

top¶

width¶

height¶

imageLeft¶

imageTop¶

imageWidth¶

imageHeight¶

clipLeft¶

clipTop¶

clipWidth¶

clipHeight¶

type¶

face¶

holdAlpha¶

imageModified¶

hitType¶

hitThreshold¶

cursor¶

cursorX¶

cursorY¶

hint¶

showParentHint¶

focusable¶

prevFocusable¶

nextFocusable¶

joinFocusChain¶

focused¶

enabled¶

nodeEnabled¶

attentionLeft¶

attentionTop¶

useAttention¶

imeMode¶

callOnPaint¶

font¶

name¶

mainImageBuffer¶

mainImageBufferForWrite¶

mainImageBufferPitch¶

provinceImageBuffer¶

provinceImageBufferForWrite¶

provinceImageBufferPitch¶

ignoreHintSensing¶

nodeFocusable¶

moveBefore¶

moveBehind¶

bringToBack¶

bringToFront¶

loadImages¶

loadProvinceImage¶

getMainPixel¶

setMainPixel¶

getMaskPixel¶

setMaskPixel¶

getProvincePixel¶

setProvincePixel¶

getLayerAt¶

releaseCapture¶

Arguments	Default	Description
`window`	` `	The window (an object of the Window class) that will own this layer. Once set, the window cannot be changed.
`parent`	` `	The layer to become the parent of this layer. Specify null to create a primary layer. A window can have only one primary layer, and when layers are used there must always be exactly one; it is the layer that is the parent of all other layers. However, some draw devices (configurable with Window.drawDevice) allow a window to have multiple primary layers. The parent of a layer can be changed with the Layer.parent property.

Arguments	Default	Description
`image`	` `	The image storage to load. If an image storage exists whose name is this storage name (without the extension) followed by _m, it is loaded as the mask (opacity) image. If an image storage exists whose name is this storage name (without the extension) followed by _p, it is loaded as the province image.
`colorkey`	`clNone`	The color key (transparent color) of the image to load. Specifying a color in 0xRRGGBB format makes that color the color key. Specifying `clPalIdx` plus a palette index makes that palette index transparent (for images with 256 colors or fewer). Specifying `clAdapt` automatically makes the color used most often in the top line of the image transparent. Specifying `clAlphaMat` plus a color value in 0xRRGGBB format composites the image onto that color using alpha blending (the ltAlpha method). For example, specifying (clAlphaMat + 0xffffff) composites the loaded image onto white. The result is a fully opaque image (note that although the image becomes fully opaque, the tag information is not changed at all in this mode).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the color from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the color from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the color at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the color at.
`color`	` `	The color to set, in 0xRRGGBB format.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to get the value from.
`y`	` `	The y coordinate (in the layer's image coordinates) to get the value from.

Arguments	Default	Description
`x`	` `	The x coordinate (in the layer's image coordinates) to set the value at.
`y`	` `	The y coordinate (in the layer's image coordinates) to set the value at.
`value`	` `	The value to set (0 to 255).

Arguments	Default	Description
`x`	` `	The x coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`y`	` `	The y coordinate, in pixels in display coordinates, of the position to look up. The display coordinates of the layer calling this method are used (not the display coordinates of the primary layer).
`exclude_self`	`false`	Whether to exclude this layer itself from the search. If false, this layer is included in the search. If true, this layer is excluded from the search and treated as if it did not exist. If omitted, false is assumed.
`get_disabled`	`false`	Whether to return disabled layer objects. If false and the layer at the position is disabled (e.g. its Layer.enabled property is false), null is returned. If true and the layer at the position is disabled, that layer object is returned. If omitted, false is assumed.

Arguments	Default	Description
`left`	` `	The left edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.left property.
`top`	` `	The top edge of the layer (in the parent layer's display coordinates), in pixels. This value can also be read and set with the Layer.top property.
`width`	`void`	The width of the layer, in pixels. This value can also be read and set with the Layer.width property. If this argument and the height argument are omitted, only the position is changed using the left and top arguments.
`height`	`void`	The height of the layer, in pixels. This value can also be read and set with the Layer.height property. If this argument and the width argument are omitted, only the position is changed using the left and top arguments.