Top | ![]() |
![]() |
![]() |
![]() |
void | gtk_snapshot_push () |
void | gtk_snapshot_push_transform () |
void | gtk_snapshot_push_opacity () |
void | gtk_snapshot_push_color_matrix () |
void | gtk_snapshot_push_repeat () |
void | gtk_snapshot_push_clip () |
void | gtk_snapshot_push_rounded_clip () |
void | gtk_snapshot_push_cross_fade () |
void | gtk_snapshot_push_blend () |
void | gtk_snapshot_pop () |
void | gtk_snapshot_offset () |
void | gtk_snapshot_get_offset () |
void | gtk_snapshot_append_node () |
cairo_t * | gtk_snapshot_append_cairo () |
void | gtk_snapshot_append_texture () |
void | gtk_snapshot_append_color () |
gboolean | gtk_snapshot_clips_rect () |
void | gtk_snapshot_render_background () |
void | gtk_snapshot_render_frame () |
void | gtk_snapshot_render_focus () |
void | gtk_snapshot_render_layout () |
void | gtk_snapshot_render_insertion_cursor () |
GtkSnapshot is an auxiliary object that assists in creating GskRenderNodes in the “snapshot” vfunc. It functions in a similar way to a cairo context, and maintains a stack of render nodes and their associated transformations.
The node at the top of the stack is the the one that gtk_snapshot_append()
operates on. Use the gtk_snapshot_push()
and gtk_snapshot_pop()
functions to
change the current node.
The only way to obtain a GtkSnapshot object is as an argument to the “snapshot” vfunc.
void gtk_snapshot_push (GtkSnapshot *snapshot
,gboolean keep_coordinates
,const char *name
,...
);
Creates a new render node, appends it to the current render
node of snapshot
, and makes it the new current render node.
snapshot |
||
keep_coordinates |
If |
|
name |
a |
[transfer none] |
... |
arguments to insert into the format string |
Since: 3.90
void gtk_snapshot_push_transform (GtkSnapshot *snapshot
,const graphene_matrix_t *transform
,const char *name
,...
);
void gtk_snapshot_push_opacity (GtkSnapshot *snapshot
,double opacity
,const char *name
,...
);
void gtk_snapshot_push_color_matrix (GtkSnapshot *snapshot
,const graphene_matrix_t *color_matrix
,const graphene_vec4_t *color_offset
,const char *name
,...
);
void gtk_snapshot_push_repeat (GtkSnapshot *snapshot
,const graphene_rect_t *bounds
,const graphene_rect_t *child_bounds
,const char *name
,...
);
void gtk_snapshot_push_clip (GtkSnapshot *snapshot
,const graphene_rect_t *bounds
,const char *name
,...
);
void gtk_snapshot_push_rounded_clip (GtkSnapshot *snapshot
,const GskRoundedRect *bounds
,const char *name
,...
);
void gtk_snapshot_push_cross_fade (GtkSnapshot *snapshot
,double progress
,const char *name
,...
);
Snapshots a cross-fade operation between two images with the
given progress
.
Until the first call to gtk_snapshot_pop()
, the start image
will be snapshot. After that call, the end image will be recorded
until the second call to gtk_snapshot_pop()
.
Calling this function requires 2 calls to gtk_snapshot_pop()
.
void gtk_snapshot_push_blend (GtkSnapshot *snapshot
,GskBlendMode blend_mode
,const char *name
,...
);
Blends together 2 images with the given blend mode.
Until the first call to gtk_snapshot_pop()
, the bottom image for the
blend operation will be recorded. After that call, the top image to
be blended will be recorded until the second call to gtk_snapshot_pop()
.
Calling this function requires 2 subsequent calls to gtk_snapshot_pop()
.
void
gtk_snapshot_pop (GtkSnapshot *snapshot
);
Removes the top element from the stack of render nodes, and appends it to the node underneath it.
Since: 3.90
void gtk_snapshot_offset (GtkSnapshot *snapshot
,int x
,int y
);
Appends a translation by (x
, y
) to the current transformation.
Since: 3.90
void gtk_snapshot_get_offset (GtkSnapshot *snapshot
,int *x
,int *y
);
Queries the offset managed by snapshot
. This offset is the
accumulated sum of calls to gtk_snapshot_offset()
.
Use this offset to determine how to offset nodes that you
manually add to the snapshot using
gtk_snapshot_append()
.
Note that other functions that add nodes for you, such as
gtk_snapshot_append_cairo()
will add this offset for
you.
void gtk_snapshot_append_node (GtkSnapshot *snapshot
,GskRenderNode *node
);
Appends node
to the current render node of snapshot
,
without changing the current node. If snapshot
does
not have a current node yet, node
will become the
initial node.
cairo_t * gtk_snapshot_append_cairo (GtkSnapshot *snapshot
,const graphene_rect_t *bounds
,const char *name
,...
);
Creates a new render node and appends it to the current render
node of snapshot
, without changing the current node.
snapshot |
||
bounds |
the bounds for the new node |
|
name |
a |
[transfer none] |
... |
arguments to insert into the format string |
Since: 3.90
void gtk_snapshot_append_texture (GtkSnapshot *snapshot
,GdkTexture *texture
,const graphene_rect_t *bounds
,const char *name
,...
);
Creates a new render node drawing the texture
into the given bounds
and appends it
to the current render node of snapshot
.
snapshot |
||
texture |
the GdkTexture to render |
|
bounds |
the bounds for the new node |
|
name |
a |
[transfer none] |
... |
arguments to insert into the format string |
void gtk_snapshot_append_color (GtkSnapshot *snapshot
,const GdkRGBA *color
,const graphene_rect_t *bounds
,const char *name
,...
);
Creates a new render node drawing the color
into the given bounds
and appends it
to the current render node of snapshot
.
You should try to avoid calling this function if color
is transparent.
snapshot |
||
color |
the GdkRGBA to draw |
|
bounds |
the bounds for the new node |
|
name |
a |
[transfer none] |
... |
arguments to insert into the format string |
gboolean gtk_snapshot_clips_rect (GtkSnapshot *snapshot
,const cairo_rectangle_int_t *bounds
);
Tests whether the rectangle is entirely outside the clip region of snapshot
.
Since: 3.90
void gtk_snapshot_render_background (GtkSnapshot *snapshot
,GtkStyleContext *context
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Creates a render node for the CSS background according to context
,
and appends it to the current node of snapshot
, without changing
the current node.
snapshot |
||
context |
the GtkStyleContext to use |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since: 3.90
void gtk_snapshot_render_frame (GtkSnapshot *snapshot
,GtkStyleContext *context
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Creates a render node for the CSS border according to context
,
and appends it to the current node of snapshot
, without changing
the current node.
snapshot |
||
context |
the GtkStyleContext to use |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since: 3.90
void gtk_snapshot_render_focus (GtkSnapshot *snapshot
,GtkStyleContext *context
,gdouble x
,gdouble y
,gdouble width
,gdouble height
);
Creates a render node for the focus outline according to context
,
and appends it to the current node of snapshot
, without changing
the current node.
snapshot |
||
context |
the GtkStyleContext to use |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
width |
rectangle width |
|
height |
rectangle height |
Since: 3.90
void gtk_snapshot_render_layout (GtkSnapshot *snapshot
,GtkStyleContext *context
,gdouble x
,gdouble y
,PangoLayout *layout
);
Creates a render node for rendering layout
according to the style
information in context
, and appends it to the current node of snapshot
,
without changing the current node.
snapshot |
||
context |
the GtkStyleContext to use |
|
x |
X origin of the rectangle |
|
y |
Y origin of the rectangle |
|
layout |
the PangoLayout to render |
Since: 3.90
void gtk_snapshot_render_insertion_cursor (GtkSnapshot *snapshot
,GtkStyleContext *context
,gdouble x
,gdouble y
,PangoLayout *layout
,int index
,PangoDirection direction
);
Draws a text caret using snapshot
at the specified index of layout
.
snapshot |
snapshot to render to |
|
context |
||
x |
X origin |
|
y |
Y origin |
|
layout |
the PangoLayout of the text |
|
index |
the index in the PangoLayout |
|
direction |
the PangoDirection of the text |
Since: 3.90