Class: Clutter::CairoTexture

Inherits:
Texture
  • Object
show all
Defined in:
(unknown)

Overview

The Clutter::CairoTextureClass struct contains only private data.

Instance Method Summary collapse

Methods inherited from Texture

#cogl_material, #cogl_material=, #cogl_texture, #cogl_texture=, #disable_slicing=, #disable_slicing?, #filename, #filename=, #filter_quality, #filter_quality=, #from_file=, #get_base_size, #get_repeat, #keep_aspect_ratio, #keep_aspect_ratio=, #keep_aspect_ratio?, #load_async, #load_async=, #load_data_async, #load_data_async=, #max_tile_waste, #pick_with_alpha, #pick_with_alpha=, #pick_with_alpha?, #pixel_format, #pixel_format=, #repeat_x=, #repeat_x?, #repeat_y=, #repeat_y?, #set_area_from_rgb_data, #set_from_rgb_data, #set_from_yuv_data, #set_repeat, #sync_size, #sync_size=, #sync_size?, #tile_waste, #tile_waste=

Methods inherited from Actor

#accessible, #actions, #actions=, #add_action, #add_action_with_name, #add_child, #add_constraint, #add_constraint_with_name, #add_effect, #add_effect_with_name, #add_transition, #allocate, #allocate_align_fill, #allocate_available_size, #allocate_preferred_size, #allocation, #allocation=, #anchor_gravity, #anchor_gravity=, #anchor_point_from_gravity=, #anchor_point_gravity, #anchor_x, #anchor_x=, #anchor_y, #anchor_y=, #animate, #animate_with_alpha, #animate_with_alphav, #animate_with_timeline, #animate_with_timelinev, #animatev, #animation, #apply_relative_transform_to_point, #apply_transform_to_point, #background_color, #background_color=, #background_color_set=, #background_color_set?, #bind_model, #bind_model_with_properties, #child_transform, #child_transform=, #child_transform_set=, #child_transform_set?, #children, #clear_actions, #clear_constraints, #clear_effects, #clip, #clip=, #clip_rect, #clip_rect=, #clip_to_allocation, #clip_to_allocation=, #clip_to_allocation?, #constraints, #constraints=, #contains, #content, #content=, #content_box, #content_box=, #content_gravity, #content_gravity=, #content_repeat, #content_repeat=, #continue_paint, #create_pango_context, #create_pango_layout, #default_paint_volume, #depth, #depth=, #destroy, #destroy_all_children, #detach_animation, #easing_delay, #easing_delay=, #easing_duration, #easing_duration=, #easing_mode, #easing_mode=, #effect=, #effects, #event, #first_child, #first_child=, #fixed_position_set, #fixed_position_set=, #fixed_position_set?, #fixed_x, #fixed_x=, #fixed_y, #fixed_y=, #flags, #flags=, #geometry=, #get_abs_allocation_vertices, #get_action, #get_allocation_box, #get_allocation_geometry, #get_allocation_vertices, #get_anchor_point, #get_background_color, #get_child_at_index, #get_child_transform, #get_clip, #get_constraint, #get_content_box, #get_content_scaling_filters, #get_effect, #get_geometry, #get_margin, #get_paint_box, #get_pivot_point, #get_position, #get_preferred_height, #get_preferred_size, #get_preferred_width, #get_rotation, #get_rotation_angle, #get_scale, #get_scale_center, #get_size, #get_transform, #get_transformation_matrix, #get_transformed_paint_volume, #get_transformed_position, #get_transformed_size, #get_transition, #get_translation, #gid, #grab_key_focus, #has_actions, #has_allocation, #has_clip, #has_clip=, #has_clip?, #has_constraints, #has_effects, #has_key_focus, #has_overlaps, #has_pointer, #has_pointer=, #has_pointer?, #height, #height=, #hide, #hide_all, #insert_child_above, #insert_child_at_index, #insert_child_below, #is_in_clone_paint, #is_mapped, #is_realized, #is_rotated, #is_scaled, #is_visible, #last_child, #last_child=, #layout_manager, #layout_manager=, #lower, #lower_bottom, #magnification_filter, #magnification_filter=, #map, #mapped=, #mapped?, #margin=, #margin_bottom, #margin_bottom=, #margin_left, #margin_left=, #margin_right, #margin_right=, #margin_top, #margin_top=, #min_height, #min_height=, #min_height_set=, #min_height_set?, #min_width, #min_width=, #min_width_set=, #min_width_set?, #minification_filter, #minification_filter=, #move_anchor_point, #move_anchor_point_from_gravity, #move_by, #n_children, #name, #name=, #natural_height, #natural_height=, #natural_height_set=, #natural_height_set?, #natural_width, #natural_width=, #natural_width_set=, #natural_width_set?, #needs_expand, #next_sibling, #offscreen_redirect, #offscreen_redirect=, #opacity, #opacity=, #paint, #paint_opacity, #paint_visibility, #paint_volume, #pango_context, #parent, #parent=, #pivot_point, #pivot_point=, #pivot_point_z, #pivot_point_z=, #pop_internal, #position, #position=, #previous_sibling, #push_internal, #queue_redraw, #queue_redraw_with_clip, #queue_relayout, #raise, #raise_top, #reactive, #reactive=, #reactive?, #realize, #realized=, #realized?, #remove_action, #remove_action_by_name, #remove_all_children, #remove_all_transitions, #remove_child, #remove_clip, #remove_constraint, #remove_constraint_by_name, #remove_effect, #remove_effect_by_name, #remove_transition, #reparent, #replace_child, #request_mode, #request_mode=, #restore_easing_state, #rotation_angle_x, #rotation_angle_x=, #rotation_angle_y, #rotation_angle_y=, #rotation_angle_z, #rotation_angle_z=, #rotation_center_x, #rotation_center_x=, #rotation_center_y, #rotation_center_y=, #rotation_center_z, #rotation_center_z=, #rotation_center_z_gravity, #rotation_center_z_gravity=, #save_easing_state, #save_easing_state_without_block, #scale_center_x, #scale_center_x=, #scale_center_y, #scale_center_y=, #scale_gravity, #scale_gravity=, #scale_x, #scale_x=, #scale_y, #scale_y=, #scale_z, #scale_z=, #set_allocation, #set_anchor_point, #set_child_above_sibling, #set_child_at_index, #set_child_below_sibling, #set_clip, #set_content_scaling_filters, #set_pivot_point, #set_position, #set_rotation, #set_rotation_angle, #set_scale, #set_scale_full, #set_scale_with_gravity, #set_shader_param, #set_shader_param_float, #set_shader_param_int, #set_size, #set_translation, #set_z_rotation_from_gravity, #shader, #shader=, #should_pick_paint, #show, #show_all, #show_on_set_parent=, #show_on_set_parent?, #size, #size=, #stage, #text_direction, #text_direction=, #transform, #transform=, #transform_set=, #transform_set?, #transform_stage_point, #translation_x, #translation_x=, #translation_y, #translation_y=, #translation_z, #translation_z=, #unmap, #unparent, #unrealize, #unset_flags, #visible=, #visible?, #width, #width=, #x, #x=, #x_align, #x_align=, #x_expand, #x_expand=, #x_expand?, #y, #y=, #y_align, #y_align=, #y_expand, #y_expand=, #y_expand?, #z_position, #z_position=, #z_rotation_gravity

Constructor Details

#initialize(width, height) ⇒ Clutter::Actor

Creates a new Clutter::CairoTexture actor, with a surface of width by height pixels.

Parameters:

  • width (Integer) —

    the width of the surface

  • height (Integer) —

    the height of the surface

Instance Method Details

#auto_resize ⇒ Boolean

Retrieves the value set using clutter_cairo_texture_set_auto_resize().

Returns:

  • (Boolean) —

    true if the Clutter::CairoTexture should track the allocation, and false otherwise

#auto_resize=(auto_resize) ⇒ Boolean

Controls whether the Clutter::CairoTexture should automatically resize the Cairo surface whenever the actor's allocation changes. If :auto-resize is set to true the surface contents will also be invalidated automatically.

Parameters:

  • auto_resize (Boolean)

Returns:

  • (Boolean) —

    auto-resize

  • (Boolean) —

    auto-resize

#auto_resize? ⇒ Boolean

Controls whether the Clutter::CairoTexture should automatically resize the Cairo surface whenever the actor's allocation changes. If :auto-resize is set to true the surface contents will also be invalidated automatically.

Returns:

  • (Boolean) —

    auto-resize

#clear ⇒ nil

Clears self's internal drawing surface, so that the next upload will replace the previous contents of the Clutter::CairoTexture rather than adding to it.

Calling this function from within a Clutter::CairoTexture::draw signal handler will clear the invalidated area.

Returns:

  • (nil)

#create ⇒ cairo::Context

Creates a new Cairo context for the cairo texture. It is similar to using clutter_cairo_texture_create_region() with x_offset and y_offset of 0, width equal to the cairo texture surface width and height equal to the cairo texture surface height.

Do not call this function within the paint virtual function or from a callback to the Clutter::Actor::paint signal.

Returns:

  • (cairo::Context) —

    a newly created Cairo context. Use cairo_destroy() to upload the contents of the context when done drawing

#create_region(x_offset, y_offset, width, height) ⇒ cairo::Context

Creates a new Cairo context that will updat the region defined by x_offset, y_offset, width and height.

Do not call this function within the paint virtual function or from a callback to the Clutter::Actor::paint signal.

Parameters:

  • x_offset (Integer) —

    offset of the region on the X axis

  • y_offset (Integer) —

    offset of the region on the Y axis

  • width (Integer) —

    width of the region, or -1 for the full surface width

  • height (Integer) —

    height of the region, or -1 for the full surface height

Returns:

  • (cairo::Context) —

    a newly created Cairo context. Use cairo_destroy() to upload the contents of the context when done drawing

#get_surface_size(width, height) ⇒ nil

Retrieves the surface width and height for self.

Parameters:

  • width (Integer) —

    return location for the surface width, or nil

  • height (Integer) —

    return location for the surface height, or nil

Returns:

  • (nil)

#invalidate ⇒ nil

Invalidates the whole surface of a Clutter::CairoTexture.

This function will cause the Clutter::CairoTexture::draw signal to be emitted.

See also: clutter_cairo_texture_invalidate_rectangle()

Returns:

  • (nil)

#invalidate_rectangle(rect) ⇒ nil

Invalidates a rectangular region of a Clutter::CairoTexture.

The invalidation will cause the Clutter::CairoTexture::draw signal to be emitted.

See also: clutter_cairo_texture_invalidate()

Parameters:

  • rect (cairo::RectangleInt) —

    a rectangle with the area to invalida, or nil to perform an unbounded invalidation

Returns:

  • (nil)

#set_surface_size(width, height) ⇒ nil

Resizes the Cairo surface used by self to width and height.

This function will not invalidate the contents of the Cairo texture: you will have to explicitly call either clutter_cairo_texture_invalidate_rectangle() or clutter_cairo_texture_invalidate().

Parameters:

  • width (Integer) —

    the new width of the surface

  • height (Integer) —

    the new height of the surface

Returns:

  • (nil)

#surface_height ⇒ Integer

The height of the Cairo surface used by the Clutter::CairoTexture actor, in pixels.

Returns:

  • (Integer) —

    surface-height

#surface_height=(surface_height) ⇒ Integer

The height of the Cairo surface used by the Clutter::CairoTexture actor, in pixels.

Parameters:

  • surface_height (Integer)

Returns:

  • (Integer) —

    surface-height

  • (Integer) —

    surface-height

#surface_width ⇒ Integer

The width of the Cairo surface used by the Clutter::CairoTexture actor, in pixels.

Returns:

  • (Integer) —

    surface-width

#surface_width=(surface_width) ⇒ Integer

The width of the Cairo surface used by the Clutter::CairoTexture actor, in pixels.

Parameters:

  • surface_width (Integer)

Returns:

  • (Integer) —

    surface-width

  • (Integer) —

    surface-width