Memory-managed wrapper type.

Type class for types which can be safely cast to Texture, for instance with toTexture.

Cast to Texture, for types for which this is known to be safe. For general casts, use castTo.

Gets the size in pixels of the untransformed underlying image

Returns a handle to the underlying COGL material used for drawing the actor.

Since: 1.0

Retrieves the handle to the underlying COGL texture used for drawing the actor. No extra reference is taken so if you need to keep the handle then you should call handleRef on it.

The texture handle returned is the first layer of the material handle used by the Texture. If you need to access the other layers you should use textureGetCoglMaterial instead and use the Material API.

Since: 0.8

Gets the filter quality used when scaling a texture.

Since: 0.8

Retrieves the value set using textureSetKeepAspectRatio

Since: 1.0

Retrieves the value set using textureSetLoadAsync

Since: 1.0

Retrieves the value set by textureSetLoadDataAsync

Since: 1.0

Gets the maximum waste that will be used when creating a texture or -1 if slicing is disabled.

Since: 0.8

Retrieves the value set by textureSetLoadDataAsync

Since: 1.4

Retrieves the pixel format used by texture. This is equivalent to:

 handle = clutter_texture_get_pixel_format (texture);

 if (handle != COGL_INVALID_HANDLE)
   format = cogl_texture_get_format (handle);

Since: 1.0

Retrieves the horizontal and vertical repeat values set using textureSetRepeat

Since: 1.0

Retrieves the value set with textureSetSyncSize

Since: 1.0

Creates a new empty Texture object.

Creates a new Texture object with its source a prexisting actor (and associated children). The textures content will contain 'live' redirected output of the actors scene.

Note this function is intented as a utility call for uniformly applying shaders to groups and other potential visual effects. It requires that the FeatureFlagsOffscreen feature is supported by the current backend and the target system.

Some tips on usage:

• The source actor must be visible
• The source actor must have a parent in order for it to be allocated a size from the layouting mechanism. If the source actor does not have a parent when this function is called then the ClutterTexture will adopt it and allocate it at its preferred size. Using this you can clone an actor that is otherwise not displayed. Because of this feature if you do intend to display the source actor then you must make sure that the actor is parented before calling textureNewFromActor or that you unparent it before adding it to a container.
• When getting the image for the clone texture, Clutter will attempt to render the source actor exactly as it would appear if it was rendered on screen. The source actor's parent transformations are taken into account. Therefore if your source actor is rotated along the X or Y axes so that it has some depth, the texture will appear differently depending on the on-screen location of the source actor. While painting the source actor, Clutter will set up a temporary asymmetric perspective matrix as the projection matrix so that the source actor will be projected as if a small section of the screen was being viewed. Before version 0.8.2, an orthogonal identity projection was used which meant that the source actor would be clipped if any part of it was not on the zero Z-plane.
• Avoid reparenting the source with the created texture.
• A group can be padded with a transparent rectangle as to provide a border to contents for shader output (blurring text for example).
• The texture will automatically resize to contain a further transformed source. However, this involves overhead and can be avoided by placing the source actor in a bounding group sized large enough to contain any child tranformations.
• Uploading pixel data to the texture (e.g by using textureSetFromFile) will destroy the offscreen texture data and end redirection.
• textureGetData with the handle returned by textureGetCoglTexture can be used to read the offscreen texture pixels into a pixbuf.

Since: 0.6

Creates a new ClutterTexture actor to display the image contained a file. If the image failed to load then NULL is returned and error is set.

Since: 0.8

Updates a sub-region of the pixel data in a Texture.

Since: 0.6

Replaces the underlying Cogl material drawn by this actor with coglMaterial. A reference to the material is taken so if the handle is no longer needed it should be deref'd with cogl_handle_unref. Texture data is attached to the material so calling this function also replaces the Cogl texture. Texture requires that the material have a texture layer so you should set one on the material before calling this function.

Since: 0.8

Replaces the underlying COGL texture drawn by this actor with coglTex. A reference to the texture is taken so if the handle is no longer needed it should be deref'd with cogl_handle_unref.

Since: 0.8

Sets the filter quality when scaling a texture. The quality is an enumeration currently the following values are supported: TextureQualityLow which is fast but only uses nearest neighbour interpolation. TextureQualityMedium which is computationally a bit more expensive (bilinear interpolation), and TextureQualityHigh which uses extra texture memory resources to improve scaled down rendering as well (by using mipmaps). The default value is TextureQualityMedium.

Since: 0.8

Sets the Texture image data from an image file. In case of failure, False is returned and error is set.

If Texture:loadAsync is set to True, this function will return as soon as possible, and the actual image loading from disk will be performed asynchronously. Texture::sizeChange will be emitten when the size of the texture is available and Texture::loadFinished will be emitted when the image has been loaded or if an error occurred.

Since: 0.8

Sets Texture image data.

Since: 0.4

Sets a Texture from YUV image data. If an error occurred, False is returned and error is set.

The YUV support depends on the driver; the format supported by the few drivers exposing this capability are not really useful.

The proper way to convert image data in any YUV colorspace to any RGB colorspace is to use a fragment shader associated with the Texture material.

Since: 0.4

Sets whether texture should have a preferred size maintaining the aspect ratio of the underlying image

Since: 1.0

Sets whether texture should use a worker thread to load the data from disk asynchronously. Setting loadAsync to True will make textureSetFromFile return immediately.

See the Texture:loadAsync property documentation, and textureSetLoadDataAsync.

Since: 1.0

Sets whether texture should use a worker thread to load the data from disk asynchronously. Setting loadAsync to True will make textureSetFromFile block until the Texture has determined the width and height of the image data.

See the Texture:loadAsync property documentation, and textureSetLoadAsync.

Since: 1.0

Sets whether texture should have it's shape defined by the alpha channel when picking.

Be aware that this is a bit more costly than the default picking due to the texture lookup, extra test against the alpha value and the fact that it will also interrupt the batching of geometry done internally.

Also there is currently no control over the threshold used to determine what value of alpha is considered pickable, and so only fully opaque parts of the texture will react to picking.

Since: 1.4

Sets whether the texture should repeat horizontally or vertically when the actor size is bigger than the image size

Since: 1.0

Sets whether texture should have the same preferred size as the underlying image data.

Since: 1.0

Construct a GValueConstruct with valid value for the “disable-slicing” property. This is rarely needed directly, but it is used by new.

Get the value of the “disable-slicing” property. When overloading is enabled, this is equivalent to

get texture #disableSlicing

Set the value of the “filename” property to Nothing. When overloading is enabled, this is equivalent to

clear #filename

Construct a GValueConstruct with valid value for the “filename” property. This is rarely needed directly, but it is used by new.

Get the value of the “filename” property. When overloading is enabled, this is equivalent to

get texture #filename

Set the value of the “filename” property. When overloading is enabled, this is equivalent to

set texture [ #filename := value ]

Construct a GValueConstruct with valid value for the “filter-quality” property. This is rarely needed directly, but it is used by new.

Get the value of the “filter-quality” property. When overloading is enabled, this is equivalent to

get texture #filterQuality

Set the value of the “filter-quality” property. When overloading is enabled, this is equivalent to

set texture [ #filterQuality := value ]

Construct a GValueConstruct with valid value for the “keep-aspect-ratio” property. This is rarely needed directly, but it is used by new.

Get the value of the “keep-aspect-ratio” property. When overloading is enabled, this is equivalent to

get texture #keepAspectRatio

Set the value of the “keep-aspect-ratio” property. When overloading is enabled, this is equivalent to

set texture [ #keepAspectRatio := value ]

Construct a GValueConstruct with valid value for the “load-async” property. This is rarely needed directly, but it is used by new.

Set the value of the “load-async” property. When overloading is enabled, this is equivalent to

set texture [ #loadAsync := value ]

Construct a GValueConstruct with valid value for the “load-data-async” property. This is rarely needed directly, but it is used by new.

Set the value of the “load-data-async” property. When overloading is enabled, this is equivalent to

set texture [ #loadDataAsync := value ]

Construct a GValueConstruct with valid value for the “pick-with-alpha” property. This is rarely needed directly, but it is used by new.

Get the value of the “pick-with-alpha” property. When overloading is enabled, this is equivalent to

get texture #pickWithAlpha

Set the value of the “pick-with-alpha” property. When overloading is enabled, this is equivalent to

set texture [ #pickWithAlpha := value ]

Get the value of the “pixel-format” property. When overloading is enabled, this is equivalent to

get texture #pixelFormat

Construct a GValueConstruct with valid value for the “repeat-x” property. This is rarely needed directly, but it is used by new.

Get the value of the “repeat-x” property. When overloading is enabled, this is equivalent to

get texture #repeatX

Set the value of the “repeat-x” property. When overloading is enabled, this is equivalent to

set texture [ #repeatX := value ]

Construct a GValueConstruct with valid value for the “repeat-y” property. This is rarely needed directly, but it is used by new.

Get the value of the “repeat-y” property. When overloading is enabled, this is equivalent to

get texture #repeatY

Set the value of the “repeat-y” property. When overloading is enabled, this is equivalent to

set texture [ #repeatY := value ]

Construct a GValueConstruct with valid value for the “sync-size” property. This is rarely needed directly, but it is used by new.

Get the value of the “sync-size” property. When overloading is enabled, this is equivalent to

get texture #syncSize

Set the value of the “sync-size” property. When overloading is enabled, this is equivalent to

set texture [ #syncSize := value ]

Get the value of the “tile-waste” property. When overloading is enabled, this is equivalent to

get texture #tileWaste

The loadFinished signal is emitted when a texture load has completed. If there was an error during loading, error will be set, otherwise it will be Nothing

Since: 1.0

Connect a signal handler for the loadFinished signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after texture #loadFinished callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the loadFinished signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on texture #loadFinished callback

The pixbufChange signal is emitted each time the pixbuf used by texture changes.

Connect a signal handler for the pixbufChange signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after texture #pixbufChange callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the pixbufChange signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on texture #pixbufChange callback

The sizeChange signal is emitted each time the size of the pixbuf used by texture changes. The new size is given as argument to the callback.

Connect a signal handler for the sizeChange signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after texture #sizeChange callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the sizeChange signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on texture #sizeChange callback