Gly.FrameRequest

g GObject.Object GObject.Object Gly.FrameRequest Gly.FrameRequest GObject.Object->Gly.FrameRequest

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

set_loop_animation (loop_animation)

set_scale (width, height)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

loop-animation

bool

r/w

scale-height

int

r

scale-width

int

r

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Gly.FrameRequest(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Gly.FrameRequestClass

Defines which parts of an image to load.

::: warning Loaders can and frequently will ignore instructions set in GlyFrameRequest. The reason is that for most loaders many instructions don’t have a meaningful interpretation.

New in version 2.0.

classmethod new()
Returns:

a new [class`FrameRequest`]

Return type:

Gly.FrameRequest

Creates a new frame request.

New in version 2.0.

set_loop_animation(loop_animation)
Parameters:

loop_animation (bool) –

Controls if first frame is returned after last frame

By default, this option is set to TRUE, returning the first frame, if the previously requested frame was the last frame.

New in version 2.0.1.

set_scale(width, height)
Parameters:
  • width (int) – Maximum width

  • height (int) – Maximum height

Set maximum dimensions for the frame. The texture will be scaled to be within the maximum dimensions while keeping its aspect ratio. This option is especially useful to SVGs which will be rendered at the respective size.

::: warning Most loaders will ignore this option. Currently, only the SVG loader is known to obay it.

New in version 2.0.

Property Details

Gly.FrameRequest.props.loop_animation
Name:

loop-animation

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Gly.FrameRequest.props.scale_height
Name:

scale-height

Type:

int

Default Value:

0

Flags:

READABLE

Gly.FrameRequest.props.scale_width
Name:

scale-width

Type:

int

Default Value:

0

Flags:

READABLE