Skip to content

Image#

The most commonly used method of defining a frame.

Example#

The following example defines a frame that is an image file:

"frames": [{
    "bmp": "my cool image.png"
}]

Attributes#

bmp#

Type: string

The relative path to the texture file of your draft.

copies#

Type: integer

By default, the value will be 0.

count#

Type: integer

By default, the value will be 1.

h#

Type: integer

By default, the value will be the height of the frame.

handle x#

Type: integer

handle y#

Type: integer

n#

Type: integer

By default, the value will be copies + 1.

place x#

Type: integer

X coordinate to place the frame in the texture space.

Only available for privileged drafts.

place y#

Type: integer

Y coordinate to place the frame in the texture space.

Only available for privileged drafts.

skip height factor#

Type: integer

By default, the value will be 0.

skip width factor#

Type: integer

By default, the value will be 1.

target h#

Type: integer

Scales the frame to the specified height.

By default, the value will be same as h.

target w#

Type: integer

Scales the frame to the specified width.

By default, the value will be same as w.

w#

Type: integer

By default, the value will be the width of the frame.

x#

Type: integer

By default, the value will be 0.

y#

Type: integer

By default, the value will be 0.