OpenGL.GL.images

Image-handling routines

### Unresolved:

Following methods are not yet resolved due to my not being sure how the function should be wrapped:

glCompressedTexImage3D glCompressedTexImage2D glCompressedTexImage1D glCompressedTexSubImage3D glCompressedTexSubImage2D glCompressedTexSubImage1D

Functions

_setDataSize( baseFunction , argument = 'imageSize' )

Set the data-size value to come from the data field

asInt( value )

asIntConverter( value , * args )

asWrapper( value )

compressedImageFunction( baseFunction )

Set the imageSize and dimensions-as-ints converters for baseFunction

glGetTexImage( target , level , format , type , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImageb( target , level , format , type = GL_BYTE , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImaged( target , level , format , type = GL_DOUBLE , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImagef( target , level , format , type = GL_FLOAT , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImagei( target , level , format , type = GL_INT , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImages( target , level , format , type = GL_SHORT , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImageub( target , level , format , type = GL_UNSIGNED_BYTE , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImageui( target , level , format , type = GL_UNSIGNED_INT , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glGetTexImageus( target , level , format , type = GL_UNSIGNED_SHORT , array = None , outputType = <type 'str'> )

Get a texture-level as an image

target: enum constant for the texture engine to be read
level: the mip-map level to read
format: image format to read out the data
type: data-type into which to read the data
array: optional array/offset into which to store the value

outputType: default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glReadPixels( x , y , width , height , format , type , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

x,y,width,height -- location and dimensions of the image to read from the buffer format -- pixel format for the resulting data type -- data-format for the resulting data array -- optional array/offset into which to store the value outputType -- default (bytes) provides string output of the results iff OpenGL.UNSIGNED_BYTE_IMAGES_AS_STRING is True and type == GL_UNSIGNED_BYTE. Any other value will cause output in the default array output format.

returns the pixel data array in the format defined by the format, type and outputType

glReadPixelsb( x , y , width , height , format , type = GL_BYTE , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsd( x , y , width , height , format , type = GL_DOUBLE , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsf( x , y , width , height , format , type = GL_FLOAT , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsi( x , y , width , height , format , type = GL_INT , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelss( x , y , width , height , format , type = GL_SHORT , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsub( x , y , width , height , format , type = GL_UNSIGNED_BYTE , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsui( x , y , width , height , format , type = GL_UNSIGNED_INT , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

glReadPixelsus( x , y , width , height , format , type = GL_UNSIGNED_SHORT , array = None , outputType = <type 'str'> )

Read specified pixels from the current display buffer

This typed version returns data in your specified default array data-type format, or in the passed array, which will be converted to the array-type required by the format.

setDimensionsAsInts( baseOperation )

Set arguments with names in INT_DIMENSION_NAMES to asInt processing

setImageInput( baseOperation , arrayType = None , dimNames = ('width', 'height', 'depth') , pixelName = 'pixels' , typeName = None )

Determine how to convert "pixels" into an image-compatible argument

typedImageFunction( suffix , arrayConstant , baseFunction )

Produce a typed version of the given image function