StTextureCache

StTextureCache

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── StTextureCache

Description

Functions

st_texture_cache_get_default ()

StTextureCache *
st_texture_cache_get_default (void);

Returns

The global texture cache.

[transfer none]


st_texture_cache_load_sliced_image ()

ClutterActor *
st_texture_cache_load_sliced_image (StTextureCache *cache,
                                    const gchar *path,
                                    gint grid_width,
                                    gint grid_height,
                                    GFunc load_callback,
                                    gpointer user_data);

This function reads a single image file which contains multiple images internally. The image file will be divided using grid_width and grid_height ; note that the dimensions of the image loaded from path should be a multiple of the specified grid dimensions.

Parameters

cache

A StTextureCache

 

path

Path to a filename

 

grid_width

Width in pixels

 

grid_height

Height in pixels

 

load_callback

Function called when the image is loaded, or NULL.

[scope async][allow-none]

user_data

Data to pass to the load callback

 

Returns

A new ClutterActor.

[transfer none]


st_texture_cache_bind_pixbuf_property ()

ClutterActor *
st_texture_cache_bind_pixbuf_property (StTextureCache *cache,
                                       GObject *object,
                                       const char *property_name);

Create a ClutterTexture which tracks the GdkPixbuf value of a GObject property named by property_name . Unlike other methods in StTextureCache, the underlying CoglTexture is not shared by default with other invocations to this method.

If the source object is destroyed, the texture will continue to show the last value of the property.

Parameters

object

A GObject with a property property_name of type GdkPixbuf

 

property_name

Name of a property

 

Returns

A new ClutterActor.

[transfer none]


st_texture_cache_load_gicon ()

ClutterActor *
st_texture_cache_load_gicon (StTextureCache *cache,
                             StThemeNode *theme_node,
                             GIcon *icon,
                             gint size);

This method returns a new ClutterActor for a given GIcon. If the icon isn't loaded already, the texture will be filled asynchronously.

Parameters

cache

The texture cache instance

 

theme_node

The StThemeNode to use for colors, or NULL if the icon must not be recolored.

[allow-none]

icon

the GIcon to load

 

size

Size of themed

 

Returns

A new ClutterActor for the icon, or an empty ClutterActor if none was found.

[transfer none]


st_texture_cache_load_icon_name ()

ClutterActor *
st_texture_cache_load_icon_name (StTextureCache *cache,
                                 StThemeNode *theme_node,
                                 const char *name,
                                 StIconType icon_type,
                                 gint size);

Load a themed icon into a texture. See the StIconType documentation for an explanation of how icon_type affects the returned icon. The colors used for symbolic icons are derived from theme_node .

Parameters

cache

The texture cache instance

 

theme_node

a StThemeNode.

[allow-none]

name

Name of a themed icon

 

icon_type

the type of icon to load

 

size

Size of themed

 

Returns

A new ClutterTexture for the icon.

[transfer none]


st_texture_cache_load_uri_async ()

ClutterActor *
st_texture_cache_load_uri_async (StTextureCache *cache,
                                 const gchar *uri,
                                 int available_width,
                                 int available_height);

Asynchronously load an image. Initially, the returned texture will have a natural size of zero. At some later point, either the image will be loaded successfully and at that point size will be negotiated, or upon an error, no image will be set.

Parameters

cache

The texture cache instance

 

uri

uri of the image file from which to create a pixbuf

 

available_width

available width for the image, can be -1 if not limited

 

available_height

available height for the image, can be -1 if not limited

 

Returns

A new ClutterActor with no image loaded initially.

[transfer none]


st_texture_cache_load_uri_sync ()

ClutterActor *
st_texture_cache_load_uri_sync (StTextureCache *cache,
                                StTextureCachePolicy policy,
                                const gchar *uri,
                                int available_width,
                                int available_height,
                                GError **error);

Synchronously load an image from a uri. The image is scaled down to fit the available width and height imensions, but the image is never scaled up beyond its actual size. The pixbuf is rotated according to the associated orientation setting.

Parameters

cache

The texture cache instance

 

policy

Requested lifecycle of cached data

 

uri

uri of the image file from which to create a pixbuf

 

available_width

available width for the image, can be -1 if not limited

 

available_height

available height for the image, can be -1 if not limited

 

error

Return location for error

 

Returns

A new ClutterActor with the image file loaded if it was generated successfully, NULL otherwise.

[transfer none]


st_texture_cache_load_file_to_cogl_texture ()

CoglTexture *
st_texture_cache_load_file_to_cogl_texture
                               (StTextureCache *cache,
                                const gchar *file_path);

This function synchronously loads the given file path into a COGL texture. On error, a warning is emitted and NULL is returned.

[skip]

Parameters

cache

A StTextureCache

 

file_path

Path to a file in supported image format

 

Returns

a new CoglTexture.

[transfer full]


st_texture_cache_load_file_to_cairo_surface ()

cairo_surface_t *
st_texture_cache_load_file_to_cairo_surface
                               (StTextureCache *cache,
                                const gchar *file_path);

This function synchronously loads the given file path into a cairo surface. On error, a warning is emitted and NULL is returned.

Parameters

cache

A StTextureCache

 

file_path

Path to a file in supported image format

 

Returns

a new cairo_surface_t.

[transfer full]


st_texture_cache_load_from_raw ()

ClutterActor *
st_texture_cache_load_from_raw (StTextureCache *cache,
                                const guchar *data,
                                gsize len,
                                gboolean has_alpha,
                                int width,
                                int height,
                                int rowstride,
                                int size,
                                GError **error);

Creates (or retrieves from cache) an icon based on raw pixel data.

Parameters

cache

a StTextureCache

 

data

raw pixel data.

[array length=len]

len

the length of data

 

has_alpha

whether data includes an alpha channel

 

width

width in pixels of data

 

height

width in pixels of data

 

rowstride

rowstride of data

 

size

size of icon to return

 

Returns

a new ClutterActor displaying a pixbuf created from data and the other parameters.

[transfer none]


st_texture_cache_load_file_simple ()

ClutterActor *
st_texture_cache_load_file_simple (StTextureCache *cache,
                                   const gchar *file_path);

Synchronously load an image into a texture. The texture will be cached indefinitely. On error, this function returns an empty texture and prints a warning.

Parameters

cache

A StTextureCache

 

file_path

Filesystem path

 

Returns

A new ClutterTexture.

[transfer none]


StTextureCacheLoader ()

CoglTexture *
(*StTextureCacheLoader) (StTextureCache *cache,
                         const char *key,
                         void *data,
                         GError **error);

See st_texture_cache_load(). Implementations should return a texture handle for the given key, or set error .

[skip]

Parameters

cache

a StTextureCache

 

key

Unique identifier for this texture

 

data

Callback user data

 

error

A GError

 

st_texture_cache_load ()

CoglTexture *
st_texture_cache_load (StTextureCache *cache,
                       const char *key,
                       StTextureCachePolicy policy,
                       StTextureCacheLoader load,
                       void *data,
                       GError **error);

Load an arbitrary texture, caching it. The string chosen for key should be of the form "type-prefix:type-uuid". For example, "url:file:///usr/share/icons/hicolor/48x48/apps/firefox.png", or "stock-icon:gtk-ok".

[skip]

Parameters

cache

A StTextureCache

 

key

Arbitrary string used to refer to item

 

policy

Caching policy

 

load

Function to create the texture, if not already cached

 

data

User data passed to load

 

error

A GError

 

Returns

A newly-referenced handle to the texture.

[transfer full]

Types and Values

enum StTextureCachePolicy

Members

ST_TEXTURE_CACHE_POLICY_NONE

   

ST_TEXTURE_CACHE_POLICY_FOREVER

   

Signal Details

The “icon-theme-changed” signal

void
user_function (StTextureCache *sttexturecache,
               gpointer        user_data)

Flags: Run Last


The “texture-file-changed” signal

void
user_function (StTextureCache *sttexturecache,
               gchar          *arg1,
               gpointer        user_data)

Flags: Run Last