core  array_cache  math  swrast  swrast_setup  tnl  tnl_dd             

---

teximage.c File Reference

Texture images manipulation functions. More...

#include "glheader.h"
#include "context.h"
#include "convolve.h"
#include "image.h"
#include "imports.h"
#include "macros.h"
#include "state.h"
#include "texcompress.h"
#include "texformat.h"
#include "teximage.h"
#include "texstate.h"
#include "texstore.h"
#include "mtypes.h"

Functions
int	logbase2 (int n)
GLint	_mesa_base_tex_format (GLcontext *ctx, GLint internalFormat)
	Return the simple base format for a given internal texture format. More...
GLboolean	is_color_format (GLenum internalFormat)
	Test if the given internal texture format is a color/RGBA format (i.e., not color index, depth, stencil, etc). More...
GLboolean	is_index_format (GLenum internalFormat)
	Test if the given internal texture format is a color index format. More...
GLboolean	is_depth_format (GLenum internalFormat)
	Test if the given internal texture format is a depth component format. More...
GLboolean	is_ycbcr_format (GLenum internalFormat)
	Test if the given internal texture format is a YCbCr format. More...
GLboolean	is_compressed_format (GLcontext *ctx, GLenum internalFormat)
	Test if it is a supported compressed format. More...
void	_mesa_set_tex_image (struct gl_texture_object *tObj, GLenum target, GLint level, struct gl_texture_image *texImage)
	Store a gl_texture_image pointer in a gl_texture_object structure according to the target and level parameters. More...
gl_texture_image *	_mesa_new_texture_image (GLcontext *ctx)
	Allocate a texture image structure. More...
void	_mesa_delete_texture_image (struct gl_texture_image *teximage)
	Free texture image. More...
GLboolean	is_proxy_target (GLenum target)
	Test if a target is a proxy target. More...
gl_texture_object *	_mesa_select_tex_object (GLcontext *ctx, const struct gl_texture_unit *texUnit, GLenum target)
	Get the texture object that corresponds to the target of the given texture unit. More...
gl_texture_image *	_mesa_select_tex_image (GLcontext *ctx, const struct gl_texture_unit *texUnit, GLenum target, GLint level)
	Get the texture image struct which corresponds to target and level of the given texture unit. More...
gl_texture_image *	_mesa_get_tex_image (GLcontext *ctx, const struct gl_texture_unit *texUnit, GLenum target, GLint level)
	Like _mesa_select_tex_image() but if the image doesn't exist, allocate it and install it. More...
gl_texture_image *	_mesa_get_proxy_tex_image (GLcontext *ctx, GLenum target, GLint level)
	Return pointer to the specified proxy texture image. More...
GLint	_mesa_max_texture_levels (GLcontext *ctx, GLenum target)
	Get the maximum number of allowed mipmap levels. More...
void	clear_teximage_fields (struct gl_texture_image *img)
	Reset the fields of a gl_texture_image struct to zero. More...
void	_mesa_init_teximage_fields (GLcontext *ctx, GLenum target, struct gl_texture_image *img, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum internalFormat)
	Initialize basic fields of the gl_texture_image struct. More...
GLboolean	_mesa_test_proxy_teximage (GLcontext *ctx, GLenum target, GLint level, GLint internalFormat, GLenum format, GLenum type, GLint width, GLint height, GLint depth, GLint border)
	This is the fallback for Driver.TestProxyTexImage(). More...
GLboolean	texture_error_check (GLcontext *ctx, GLenum target, GLint level, GLint internalFormat, GLenum format, GLenum type, GLuint dimensions, GLint width, GLint height, GLint depth, GLint border)
	Test the glTexImage[123]D() parameters for errors. More...
GLboolean	subtexture_error_check (GLcontext *ctx, GLuint dimensions, GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLint width, GLint height, GLint depth, GLenum format, GLenum type)
	Test glTexSubImage[123]D() parameters for errors. More...
GLboolean	copytexture_error_check (GLcontext *ctx, GLuint dimensions, GLenum target, GLint level, GLint internalFormat, GLint width, GLint height, GLint border)
	Test glCopyTexImage[12]D() parameters for errors. More...
GLboolean	copytexsubimage_error_check (GLcontext *ctx, GLuint dimensions, GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height)
	Test glCopyTexImage[12]D() parameters for errors. More...
void GLAPIENTRY	_mesa_GetTexImage (GLenum target, GLint level, GLenum format, GLenum type, GLvoid *pixels)
	Get texture image. More...
void GLAPIENTRY	_mesa_TexImage1D (GLenum target, GLint level, GLint internalFormat, GLsizei width, GLint border, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexImage2D (GLenum target, GLint level, GLint internalFormat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexImage3D (GLenum target, GLint level, GLint internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexImage3DEXT (GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexSubImage1D (GLenum target, GLint level, GLint xoffset, GLsizei width, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexSubImage2D (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_TexSubImage3D (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLenum type, const GLvoid *pixels)
void GLAPIENTRY	_mesa_CopyTexImage1D (GLenum target, GLint level, GLenum internalFormat, GLint x, GLint y, GLsizei width, GLint border)
void GLAPIENTRY	_mesa_CopyTexImage2D (GLenum target, GLint level, GLenum internalFormat, GLint x, GLint y, GLsizei width, GLsizei height, GLint border)
void GLAPIENTRY	_mesa_CopyTexSubImage1D (GLenum target, GLint level, GLint xoffset, GLint x, GLint y, GLsizei width)
void GLAPIENTRY	_mesa_CopyTexSubImage2D (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint x, GLint y, GLsizei width, GLsizei height)
void GLAPIENTRY	_mesa_CopyTexSubImage3D (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLint x, GLint y, GLsizei width, GLsizei height)
GLenum	compressed_texture_error_check (GLcontext *ctx, GLint dimensions, GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLsizei imageSize)
	Error checking for glCompressedTexImage[123]D(). More...
GLenum	compressed_subtexture_error_check (GLcontext *ctx, GLint dimensions, GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLsizei imageSize)
	Error checking for glCompressedTexSubImage[123]D(). More...
void GLAPIENTRY	_mesa_CompressedTexImage1DARB (GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLint border, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_CompressedTexImage2DARB (GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLint border, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_CompressedTexImage3DARB (GLenum target, GLint level, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_CompressedTexSubImage1DARB (GLenum target, GLint level, GLint xoffset, GLsizei width, GLenum format, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_CompressedTexSubImage2DARB (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLsizei width, GLsizei height, GLenum format, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_CompressedTexSubImage3DARB (GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint zoffset, GLsizei width, GLsizei height, GLsizei depth, GLenum format, GLsizei imageSize, const GLvoid *data)
void GLAPIENTRY	_mesa_GetCompressedTexImageARB (GLenum target, GLint level, GLvoid *img)

---

Detailed Description

Texture images manipulation functions.

Note:

Mesa's native texture data type is GLchan. Native formats are GL_ALPHA, GL_LUMINANCE, GL_LUMANCE_ALPHA, GL_INTENSITY, GL_RGB, GL_RGBA, and GL_COLOR_INDEX.

Note:

Device drivers are free to implement any internal format they want.

---

Function Documentation

GLint _mesa_base_tex_format (  GLcontext *    ctx, GLint    internalFormat )

Return the simple base format for a given internal texture format. For example, given GL_LUMINANCE12_ALPHA4, return GL_LUMINANCE_ALPHA. Parameters: ctx  GL context. internalFormat  the internal texture format token or 1, 2, 3, or 4. Returns: the corresponding \u base internal format (GL_ALPHA, GL_LUMINANCE, GL_LUMANCE_ALPHA, GL_INTENSITY, GL_RGB, or GL_RGBA), or -1 if invalid enum. This is the format which is used during texture application (i.e. the texture format and env mode determine the arithmetic used.

void GLAPIENTRY _mesa_CompressedTexImage1DARB (  GLenum    target, GLint    level, GLenum    internalformat, GLsizei    width, GLint    border, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CompressedTexImage2DARB (  GLenum    target, GLint    level, GLenum    internalformat, GLsizei    width, GLsizei    height, GLint    border, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CompressedTexImage3DARB (  GLenum    target, GLint    level, GLenum    internalformat, GLsizei    width, GLsizei    height, GLsizei    depth, GLint    border, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CompressedTexSubImage1DARB (  GLenum    target, GLint    level, GLint    xoffset, GLsizei    width, GLenum    format, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CompressedTexSubImage2DARB (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLsizei    width, GLsizei    height, GLenum    format, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CompressedTexSubImage3DARB (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLsizei    width, GLsizei    height, GLsizei    depth, GLenum    format, GLsizei    imageSize, const GLvoid *    data )

void GLAPIENTRY _mesa_CopyTexImage1D (  GLenum    target, GLint    level, GLenum    internalformat, GLint    x, GLint    y, GLsizei    width, GLint    border )

void GLAPIENTRY _mesa_CopyTexImage2D (  GLenum    target, GLint    level, GLenum    internalformat, GLint    x, GLint    y, GLsizei    width, GLsizei    height, GLint    border )

void GLAPIENTRY _mesa_CopyTexSubImage1D (  GLenum    target, GLint    level, GLint    xoffset, GLint    x, GLint    y, GLsizei    width )

void GLAPIENTRY _mesa_CopyTexSubImage2D (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    x, GLint    y, GLsizei    width, GLsizei    height )

void GLAPIENTRY _mesa_CopyTexSubImage3D (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLint    x, GLint    y, GLsizei    width, GLsizei    height )

void _mesa_delete_texture_image (  struct gl_texture_image *    teximage )

Free texture image. Parameters: teximage  texture image. Free the texture image structure and the associated image data if it's not marked as client data.

struct gl_texture_image* _mesa_get_proxy_tex_image (  GLcontext *    ctx, GLenum    target, GLint    level )

Return pointer to the specified proxy texture image. Note that proxy textures are per-context, not per-texture unit. Returns: pointer to texture image or NULL if invalid target, invalid level, or out of memory.

struct gl_texture_image* _mesa_get_tex_image (  GLcontext *    ctx, const struct gl_texture_unit *    texUnit, GLenum    target, GLint    level )

Like _mesa_select_tex_image() but if the image doesn't exist, allocate it and install it. Only return NULL if passed a bad parameter or run out of memory.

void GLAPIENTRY _mesa_GetCompressedTexImageARB (  GLenum    target, GLint    lod, GLvoid *    img )

void GLAPIENTRY _mesa_GetTexImage (  GLenum    target, GLint    level, GLenum    format, GLenum    type, GLvoid *    pixels )

Get texture image. Called by glGetTexImage. Parameters: target  texture target. level  image level. format  pixel data format for returned image. type  pixel data type for returned image. pixels  returned pixel data.

void _mesa_init_teximage_fields (  GLcontext *    ctx, GLenum    target, struct gl_texture_image *    img, GLsizei    width, GLsizei    height, GLsizei    depth, GLint    border, GLenum    internalFormat )

Initialize basic fields of the gl_texture_image struct. Parameters: ctx  GL context. target  texture target. img  texture image structure to be initialized. width  image width. height  image height. depth  image depth. border  image border. internalFormat  internal format. Fills in the fields of img with the given information. Note: width, height and depth include the border.

GLint _mesa_max_texture_levels (  GLcontext *    ctx, GLenum    target )

Get the maximum number of allowed mipmap levels. Parameters: ctx  GL context. target  texture target. Returns: the maximum number of allowed mipmap levels for the given texture target, or zero if passed a bad target. See also: gl_constants.

struct gl_texture_image* _mesa_new_texture_image (  GLcontext *    ctx )

Allocate a texture image structure. Called via ctx->Driver.NewTextureImage() unless overriden by a device driver. Returns: a pointer to gl_texture_image struct with all fields initialized to zero.

struct gl_texture_image* _mesa_select_tex_image (  GLcontext *    ctx, const struct gl_texture_unit *    texUnit, GLenum    target, GLint    level )

Get the texture image struct which corresponds to target and level of the given texture unit. Parameters: ctx  GL context. texUnit  texture unit. target  texture target. level  image level. Returns: pointer to the texture image structure on success, or NULL on failure. See also: gl_texture_unit.

struct gl_texture_object* _mesa_select_tex_object (  GLcontext *    ctx, const struct gl_texture_unit *    texUnit, GLenum    target )

Get the texture object that corresponds to the target of the given texture unit. Parameters: ctx  GL context. texUnit  texture unit. target  texture target. Returns: pointer to the texture object on success, or NULL on failure. See also: gl_texture_unit.

void _mesa_set_tex_image (  struct gl_texture_object *    tObj, GLenum    target, GLint    level, struct gl_texture_image *    texImage )

Store a gl_texture_image pointer in a gl_texture_object structure according to the target and level parameters. Parameters: tObj  texture object. target  texture target. level  image level. texImage  texture image. This was basically prompted by the introduction of cube maps.

GLboolean _mesa_test_proxy_teximage (  GLcontext *    ctx, GLenum    target, GLint    level, GLint    internalFormat, GLenum    format, GLenum    type, GLint    width, GLint    height, GLint    depth, GLint    border )

This is the fallback for Driver.TestProxyTexImage(). Test the texture level, width, height and depth against the ctx->Const limits for textures. A hardware driver might override this function if, for example, the max 3D texture size is 512x512x64 (i.e. not a cube). Parameters: target  one of GL_PROXY_TEXTURE_1D, GL_PROXY_TEXTURE_2D, GL_PROXY_TEXTURE_3D, GL_PROXY_TEXTURE_RECTANGLE_NV, GL_PROXY_TEXTURE_CUBE_MAP_ARB. level  as passed to glTexImage internalFormat  as passed to glTexImage format  as passed to glTexImage type  as passed to glTexImage width  as passed to glTexImage height  as passed to glTexImage depth  as passed to glTexImage border  as passed to glTexImage Returns: GL_TRUE if the image is acceptable, GL_FALSE if not acceptable.

void GLAPIENTRY _mesa_TexImage1D (  GLenum    target, GLint    level, GLint    internalformat, GLsizei    width, GLint    border, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexImage2D (  GLenum    target, GLint    level, GLint    internalformat, GLsizei    width, GLsizei    height, GLint    border, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexImage3D (  GLenum    target, GLint    level, GLint    internalformat, GLsizei    width, GLsizei    height, GLsizei    depth, GLint    border, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexImage3DEXT (  GLenum    target, GLint    level, GLenum    internalformat, GLsizei    width, GLsizei    height, GLsizei    depth, GLint    border, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexSubImage1D (  GLenum    target, GLint    level, GLint    xoffset, GLsizei    width, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexSubImage2D (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLsizei    width, GLsizei    height, GLenum    format, GLenum    type, const GLvoid *    pixels )

void GLAPIENTRY _mesa_TexSubImage3D (  GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLsizei    width, GLsizei    height, GLsizei    depth, GLenum    format, GLenum    type, const GLvoid *    pixels )

void clear_teximage_fields (  struct gl_texture_image *    img )  [static]

Reset the fields of a gl_texture_image struct to zero. Parameters: img  texture image structure. This is called when a proxy texture test fails, we set all the image members (except DriverData) to zero. It's also used in glTexImage[123]D as a safeguard to be sure all required fields get initialized properly by the Driver.TexImage[123]D functions.

GLenum compressed_subtexture_error_check (  GLcontext *    ctx, GLint    dimensions, GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLsizei    width, GLsizei    height, GLsizei    depth, GLenum    format, GLsizei    imageSize )  [static]

Error checking for glCompressedTexSubImage[123]D(). Returns: error code or GL_NO_ERROR.

GLenum compressed_texture_error_check (  GLcontext *    ctx, GLint    dimensions, GLenum    target, GLint    level, GLenum    internalFormat, GLsizei    width, GLsizei    height, GLsizei    depth, GLint    border, GLsizei    imageSize )  [static]

Error checking for glCompressedTexImage[123]D(). Returns: error code or GL_NO_ERROR.

GLboolean copytexsubimage_error_check (  GLcontext *    ctx, GLuint    dimensions, GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLsizei    width, GLsizei    height )  [static]

Test glCopyTexImage[12]D() parameters for errors. Parameters: ctx  GL context. dimensions  texture image dimensions (must be 1, 2 or 3). target  texture target given by the user. level  image level given by the user. xoffset  sub-image x offset given by the user. yoffset  sub-image y offset given by the user. zoffset  sub-image z offset given by the user. width  image width given by the user. height  image height given by the user. Returns: GL_TRUE if an error was detected, or GL_FALSE if no errors. Verifies each of the parameters against the constants specified in __GLcontextRec::Const and the supported extensions, and according to the OpenGL specification.

GLboolean copytexture_error_check (  GLcontext *    ctx, GLuint    dimensions, GLenum    target, GLint    level, GLint    internalFormat, GLint    width, GLint    height, GLint    border )  [static]

Test glCopyTexImage[12]D() parameters for errors. Parameters: ctx  GL context. dimensions  texture image dimensions (must be 1, 2 or 3). target  texture target given by the user. level  image level given by the user. internalFormat  internal format given by the user. width  image width given by the user. height  image height given by the user. depth  image depth given by the user. border  texture border. Returns: GL_TRUE if an error was detected, or GL_FALSE if no errors. Verifies each of the parameters against the constants specified in __GLcontextRec::Const and the supported extensions, and according to the OpenGL specification.

GLboolean is_color_format (  GLenum    internalFormat )  [static]

Test if the given internal texture format is a color/RGBA format (i.e., not color index, depth, stencil, etc). Parameters: internalFormat  an internal texture format token (or 1, 2, 3, or 4) Returns: GL_TRUE if its a color/RGBA format, GL_FALSE otherwise.

GLboolean is_compressed_format (  GLcontext *    ctx, GLenum    internalFormat )  [static]

Test if it is a supported compressed format. Parameters: internalFormat  the internal format token provided by the user. \ret GL_TRUE if internalFormat is a supported compressed format, or GL_FALSE otherwise. Currently only GL_COMPRESSED_RGB_FXT1_3DFX and GL_COMPRESSED_RGBA_FXT1_3DFX are supported.

GLboolean is_depth_format (  GLenum    internalFormat )  [static]

Test if the given internal texture format is a depth component format.

GLboolean is_index_format (  GLenum    internalFormat )  [static]

Test if the given internal texture format is a color index format.

GLboolean is_proxy_target (  GLenum    target )  [static]

Test if a target is a proxy target. Parameters: target  texture target. Returns: GL_TRUE if the target is a proxy target, GL_FALSE otherwise.

GLboolean is_ycbcr_format (  GLenum    internalFormat )  [static]

Test if the given internal texture format is a YCbCr format.

int logbase2 (  int    n )  [static]

GLboolean subtexture_error_check (  GLcontext *    ctx, GLuint    dimensions, GLenum    target, GLint    level, GLint    xoffset, GLint    yoffset, GLint    zoffset, GLint    width, GLint    height, GLint    depth, GLenum    format, GLenum    type )  [static]

Test glTexSubImage[123]D() parameters for errors. Parameters: ctx  GL context. dimensions  texture image dimensions (must be 1, 2 or 3). target  texture target given by the user. level  image level given by the user. xoffset  sub-image x offset given by the user. yoffset  sub-image y offset given by the user. zoffset  sub-image z offset given by the user. format  pixel data format given by the user. type  pixel data type given by the user. width  image width given by the user. height  image height given by the user. depth  image depth given by the user. Returns: GL_TRUE if an error was detected, or GL_FALSE if no errors. Verifies each of the parameters against the constants specified in __GLcontextRec::Const and the supported extensions, and according to the OpenGL specification.

GLboolean texture_error_check (  GLcontext *    ctx, GLenum    target, GLint    level, GLint    internalFormat, GLenum    format, GLenum    type, GLuint    dimensions, GLint    width, GLint    height, GLint    depth, GLint    border )  [static]

Test the glTexImage[123]D() parameters for errors. Parameters: ctx  GL context. target  texture target given by the user. level  image level given by the user. internalFormat  internal format given by the user. format  pixel data format given by the user. type  pixel data type given by the user. dimensions  texture image dimensions (must be 1, 2 or 3). width  image width given by the user. height  image height given by the user. depth  image depth given by the user. border  image border given by the user. Returns: GL_TRUE if an error was detected, or GL_FALSE if no errors. Verifies each of the parameters against the constants specified in __GLcontextRec::Const and the supported extensions, and according to the OpenGL specification.

---