Image handling

Structures and functions for working with images. More...

Functions
GIuint GIAPIENTRY	giGenImage ()
	Create new image object.
void GIAPIENTRY	giGenImages (GIsizei n, GIuint *images)
	Create new image objects.
void GIAPIENTRY	giBindImage (GIuint image)
	Bind image to a specified attribute type.
void GIAPIENTRY	giDeleteImage (GIuint image)
	Delete image and all associated data.
void GIAPIENTRY	giDeleteImages (GIsizei n, const GIuint *images)
	Delete image objects.
void GIAPIENTRY	giImageExternalData (GIsizei width, GIsizei height, GIsizei components, GIenum type, GIvoid *data)
	Set image to work on external data.
void GIAPIENTRY	giImageGLTextureData (GIsizei width, GIsizei height, GIsizei components, GIenum type, GIuint texture)
	Set image to work on OpenGL texture.
void GIAPIENTRY	giImageGLBufferData (GIsizei width, GIsizei height, GIsizei components, GIenum type, GIuint buffer)
	Set image to work on OpenGL buffer.
void GIAPIENTRY	giSubImage (GIuint x, GIuint y, GIsizei width, GIsizei height)
	Set sub-image to work on.
void GIAPIENTRY	giGetImageiv (GIenum pname, GIint *param)
	Retrieve integer property of current attribute image.

---

Detailed Description

Structures and functions for working with images.

---

Function Documentation

GIuint GIAPIENTRY giGenImage

(

)

Create new image object.

Returns:

id of new image

void GIAPIENTRY giGenImages	(	GIsizei	n,
		GIuint *	images
	)

Create new image objects.

Parameters:

n	number of images to create
images	array to store ids of newly created images

void GIAPIENTRY giBindImage

(

GIuint

image

)

Bind image to a specified attribute type.

Parameters:

image

id of image to bind

void GIAPIENTRY giDeleteImage

(

GIuint

image

)

Delete image and all associated data.

Parameters:

image

id of image to delete

void GIAPIENTRY giDeleteImages	(	GIsizei	n,
		const GIuint *	images
	)

Delete image objects.

Parameters:

n	number of images to delete
images	ids of images to delete

void GIAPIENTRY giImageExternalData	(	GIsizei	width,
		GIsizei	height,
		GIsizei	components,
		GIenum	type,
		GIvoid *	data
	)

Set image to work on external data.

This function tells the image to store its data at an external memory address. The caller is responsible for allocating and releasing the neccessary data. A call to this function destroys the effect of a previous call to giImage***Data().

Parameters:

width	width of image > 1
height	height of image > 1
components	number of components in [1,4]
type	data type of image elements
data	address of appropriately sized image data in user-owned memory

void GIAPIENTRY giImageGLTextureData	(	GIsizei	width,
		GIsizei	height,
		GIsizei	components,
		GIenum	type,
		GIuint	texture
	)

Set image to work on OpenGL texture.

This function tells the image to store its data in an OpenGL texture object. The caller is responsible for creating and deleting the texture object. A call to this function destroys the effect of a previous call to giImage***Data().

Parameters:

width	width of image > 1
height	height of image > 1
components	number of components in [1,4]
type	data type of image elements
texture	name of appropriately sized user-owned OpenGL texture object

void GIAPIENTRY giImageGLBufferData	(	GIsizei	width,
		GIsizei	height,
		GIsizei	components,
		GIenum	type,
		GIuint	buffer
	)

Set image to work on OpenGL buffer.

This function tells the image to store its data in an OpenGL buffer object. The caller is responsible for creating and deleting the buffer object. A call to this function destroys the effect of a previous call to giImage***Data().

Parameters:

width	width of image > 1
height	height of image > 1
components	number of components in [1,4]
type	data type of image elements
buffer	name of appropriately sized user-owned OpenGL buffer object

void GIAPIENTRY giSubImage	(	GIuint	x,
		GIuint	y,
		GIsizei	width,
		GIsizei	height
	)

Set sub-image to work on.

This function selects a sub-rectangle of the currently bound image on which every following image operation works.

Parameters:

x	x-offset
y	y-offset
width	width of sub-rectangle
height	height of sub-rectangle

void GIAPIENTRY giGetImageiv	(	GIenum	pname,
		GIint *	param
	)

Retrieve integer property of current attribute image.

Parameters:

pname	parameter to querry
param	address of variable to store value