![]() |
![]() |
![]() |
Cogl 2.0 Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
CoglTexture; CoglBool cogl_is_texture (void *object
); unsigned int cogl_texture_get_width (CoglTexture *texture
); unsigned int cogl_texture_get_height (CoglTexture *texture
); CoglPixelFormat cogl_texture_get_format (CoglTexture *texture
); CoglBool cogl_texture_is_sliced (CoglTexture *texture
); int cogl_texture_get_data (CoglTexture *texture
,CoglPixelFormat format
,unsigned int rowstride
,uint8_t *data
); CoglBool cogl_texture_set_data (CoglTexture *texture
,CoglPixelFormat format
,int rowstride
,const uint8_t *data
,int level
,CoglError **error
); CoglBool cogl_texture_set_region (CoglTexture *texture
,int src_x
,int src_y
,int dst_x
,int dst_y
,unsigned int dst_width
,unsigned int dst_height
,int width
,int height
,CoglPixelFormat format
,unsigned int rowstride
,const uint8_t *data
); enum CoglTextureType;
Cogl allows creating and manipulating textures using a uniform API that tries to hide all the various complexities of creating, loading and manipulating textures.
CoglBool cogl_is_texture (void *object
);
Gets whether the given object references a texture object.
|
A CoglObject pointer |
Returns : |
TRUE if the object references a texture, and
FALSE otherwise |
unsigned int cogl_texture_get_width (CoglTexture *texture
);
Queries the width of a cogl texture.
|
a CoglTexture pointer. |
Returns : |
the width of the GPU side texture in pixels |
unsigned int cogl_texture_get_height (CoglTexture *texture
);
Queries the height of a cogl texture.
|
a CoglTexture pointer. |
Returns : |
the height of the GPU side texture in pixels |
CoglPixelFormat cogl_texture_get_format (CoglTexture *texture
);
Queries the CoglPixelFormat of a cogl texture.
|
a CoglTexture pointer. |
Returns : |
the CoglPixelFormat of the GPU side texture |
CoglBool cogl_texture_is_sliced (CoglTexture *texture
);
Queries if a texture is sliced (stored as multiple GPU side tecture objects).
|
a CoglTexture pointer. |
Returns : |
TRUE if the texture is sliced, FALSE if the texture
is stored as a single GPU texture |
int cogl_texture_get_data (CoglTexture *texture
,CoglPixelFormat format
,unsigned int rowstride
,uint8_t *data
);
Copies the pixel data from a cogl texture to system memory.
cogl_texture_get_rowstride()
as the
rowstride
argument, the rowstride should be the rowstride you
want for the destination data
buffer not the rowstride of the
source texture
|
a CoglTexture pointer. |
|
the CoglPixelFormat to store the texture as. |
|
the rowstride of data in bytes or pass 0 to calculate
from the bytes-per-pixel of format multiplied by the
texture width. |
|
memory location to write the texture 's contents, or NULL
to only query the data size through the return value. |
Returns : |
the size of the texture data in bytes |
CoglBool cogl_texture_set_data (CoglTexture *texture
,CoglPixelFormat format
,int rowstride
,const uint8_t *data
,int level
,CoglError **error
);
Sets all the pixels for a given mipmap level
by copying the pixel
data pointed to by the data
argument into the given texture
.
data
should point to the first pixel to copy corresponding
to the top left of the mipmap level
being set.
If rowstride
equals 0 then it will be automatically calculated
from the width of the mipmap level and the bytes-per-pixel for the
given format
.
A mipmap level
of 0 corresponds to the largest, base image of a
texture and level
1 is half the width and height of level 0. If
dividing any dimension of the previous level by two results in a
fraction then round the number down (floor()
), but clamp to 1
something like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
You can determine the number of mipmap levels for a given texture like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
Where max_dimension
is the larger of cogl_texture_get_width()
and
cogl_texture_get_height()
.
It is an error to pass a level
number >= the number of levels that
texture
can have according to the above calculation.
texture
has not previously been allocated then this
api can return FALSE
and throw an exceptional error
if there is
not enough memory to allocate storage for texture
.
|
the CoglPixelFormat used in the source data buffer. |
|
rowstride of the source data buffer (computed from
the texture width and format if it equals 0) |
|
the source data, pointing to the first top-left pixel to set |
|
The mipmap level to update (Normally 0 for the largest, base texture) |
|
A CoglError to return exceptional errors |
Returns : |
TRUE if the data upload was successful, and
FALSE otherwise |
CoglBool cogl_texture_set_region (CoglTexture *texture
,int src_x
,int src_y
,int dst_x
,int dst_y
,unsigned int dst_width
,unsigned int dst_height
,int width
,int height
,CoglPixelFormat format
,unsigned int rowstride
,const uint8_t *data
);
Sets the pixels in a rectangular subregion of texture
from an in-memory
buffer containing pixel data.
data
|
a CoglTexture. |
|
upper left coordinate to use from source data. |
|
upper left coordinate to use from source data. |
|
upper left destination horizontal coordinate. |
|
upper left destination vertical coordinate. |
|
width of destination region to write. (Must be less
than or equal to width ) |
|
height of destination region to write. (Must be less
than or equal to height ) |
|
width of source data buffer. |
|
height of source data buffer. |
|
the CoglPixelFormat used in the source buffer. |
|
rowstride of source buffer (computed from width if none specified) |
|
the actual pixel data. |
Returns : |
TRUE if the subregion upload was successful, and
FALSE otherwise |
typedef enum { COGL_TEXTURE_TYPE_2D, COGL_TEXTURE_TYPE_3D, COGL_TEXTURE_TYPE_RECTANGLE } CoglTextureType;
Constants representing the underlying hardware texture type of a CoglTexture.
Since 1.10
Stability Level: Unstable