OpenGL.GL.images
index
/home/mcfletch/pylive/OpenGL/GL/images.py

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

 
Modules
       
OpenGL.arrays
ctypes
OpenGL.images
OpenGL.platform
OpenGL.raw.GL
OpenGL.wrapper

 
Classes
       
object
CompressedImageConverter
ImageInputConverter
TypedImageInputConverter

 
class CompressedImageConverter(object)
     Methods defined here:
__call__(self, pyArgs, index, wrappedOperation)
Create a data-size measurement for our image
finalise(self, wrapper)
Get our pixel index from the wrapper

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class ImageInputConverter(object)
     Methods defined here:
__call__(self, arg, baseOperation, pyArgs)
pyConverter for the pixels argument
__init__(self, rank, pixelsName=None, typeName='type')
finalise(self, wrapper)
Get our pixel index from the wrapper

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class TypedImageInputConverter(ImageInputConverter)
    
Method resolution order:
TypedImageInputConverter
ImageInputConverter
object

Methods defined here:
__call__(self, arg, baseOperation, pyArgs)
The pyConverter for the pixels
__init__(self, rank, pixelsName, arrayType, typeName=None)
depth(self, pyArgs, index, wrappedOperation)
Extract the depth from the pixels argument
finalise(self, wrapper)
Get our pixel index from the wrapper
height(self, pyArgs, index, wrappedOperation)
Extract the height from the pixels argument
type(self, pyArgs, index, wrappedOperation)
Provide the item-type argument from our stored value
 
This is used for pre-bound processing where we want to provide 
the type by implication...
width(self, pyArgs, index, wrappedOperation)
Extract the width from the pixels argument

Data descriptors inherited from ImageInputConverter:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
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, 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
 
outputType -- default (str) 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 = glGetTexImage(target, level, format, type=GL_BYTE)
Get a texture-level as an image
glGetTexImaged = glGetTexImage(target, level, format, type=GL_DOUBLE)
Get a texture-level as an image
glGetTexImagef = glGetTexImage(target, level, format, type=GL_FLOAT)
Get a texture-level as an image
glGetTexImagei = glGetTexImage(target, level, format, type=GL_INT)
Get a texture-level as an image
glGetTexImages = glGetTexImage(target, level, format, type=GL_SHORT)
Get a texture-level as an image
glGetTexImageub = glGetTexImage(target, level, format, type=GL_UNSIGNED_BYTE)
Get a texture-level as an image
glGetTexImageui = glGetTexImage(target, level, format, type=GL_UNSIGNED_INT)
Get a texture-level as an image
glGetTexImageus = glGetTexImage(target, level, format, type=GL_UNSIGNED_SHORT)
Get a texture-level as an image
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 (str) 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 = glReadPixels(x, y, width, height, format, type=GL_BYTE, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_DOUBLE, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_FLOAT, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_INT, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_SHORT, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_UNSIGNED_BYTE, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_UNSIGNED_INT, array=None)
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 = glReadPixels(x, y, width, height, format, type=GL_UNSIGNED_SHORT, array=None)
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

 
Data
        DATA_SIZE_NAMES = ('imageSize',)
DIMENSION_NAMES = ('width', 'height', 'depth')
INT_DIMENSION_NAMES = ['width', 'height', 'depth', 'x', 'y', 'z', 'xoffset', 'yoffset', 'zoffset', 'start', 'count']
PIXEL_NAMES = ('pixels', 'row', 'column')
__all__ = ('glReadPixels', 'glReadPixelsb', 'glReadPixelsd', 'glReadPixelsf', 'glReadPixelsi', 'glReadPixelss', 'glReadPixelsub', 'glReadPixelsui', 'glReadPixelsus', 'glGetTexImage', 'glDrawPixels', 'glDrawPixelsb', 'glDrawPixelsf', 'glDrawPixelsi', 'glDrawPixelss', 'glDrawPixelsub', 'glDrawPixelsui', 'glDrawPixelsus', 'glTexSubImage2D', 'glTexSubImage1D', ...)
__file__ = '/home/mcfletch/pylive/OpenGL/GL/images.pyc'
__name__ = 'OpenGL.GL.images'
__package__ = 'OpenGL.GL'
glDrawPixels = <OpenGL.wrapper.glDrawPixels object at 0x26b72d8>
glDrawPixelsb = <OpenGL.wrapper.glDrawPixels object at 0x26bb098>
glDrawPixelsf = <OpenGL.wrapper.glDrawPixels object at 0x26bb7a0>
glDrawPixelsi = <OpenGL.wrapper.glDrawPixels object at 0x26bbea8>
glDrawPixelss = <OpenGL.wrapper.glDrawPixels object at 0x26bd5f0>
glDrawPixelsub = <OpenGL.wrapper.glDrawPixels object at 0x26bdcf8>
glDrawPixelsui = <OpenGL.wrapper.glDrawPixels object at 0x26c0440>
glDrawPixelsus = <OpenGL.wrapper.glDrawPixels object at 0x26c0b48>
glTexImage1D = <OpenGL.wrapper.glTexImage1D object at 0x26b7758>
glTexImage1Db = <OpenGL.wrapper.glTexImage1D object at 0x26b79e0>
glTexImage1Df = <OpenGL.wrapper.glTexImage1D object at 0x26bb200>
glTexImage1Di = <OpenGL.wrapper.glTexImage1D object at 0x26bb908>
glTexImage1Ds = <OpenGL.wrapper.glTexImage1D object at 0x26bd050>
glTexImage1Dub = <OpenGL.wrapper.glTexImage1D object at 0x26bd758>
glTexImage1Dui = <OpenGL.wrapper.glTexImage1D object at 0x26bde60>
glTexImage1Dus = <OpenGL.wrapper.glTexImage1D object at 0x26c05a8>
glTexImage2D = <OpenGL.wrapper.glTexImage2D object at 0x26b7638>
glTexImage2Db = <OpenGL.wrapper.glTexImage2D object at 0x26b7c20>
glTexImage2Df = <OpenGL.wrapper.glTexImage2D object at 0x26bb368>
glTexImage2Di = <OpenGL.wrapper.glTexImage2D object at 0x26bba70>
glTexImage2Ds = <OpenGL.wrapper.glTexImage2D object at 0x26bd1b8>
glTexImage2Dub = <OpenGL.wrapper.glTexImage2D object at 0x26bd8c0>
glTexImage2Dui = <OpenGL.wrapper.glTexImage2D object at 0x26bdfc8>
glTexImage2Dus = <OpenGL.wrapper.glTexImage2D object at 0x26c0710>
glTexSubImage1D = <OpenGL.wrapper.glTexSubImage1D object at 0x26b7518>
glTexSubImage1Db = <OpenGL.wrapper.glTexSubImage1D object at 0x26b7d88>
glTexSubImage1Df = <OpenGL.wrapper.glTexSubImage1D object at 0x26bb4d0>
glTexSubImage1Di = <OpenGL.wrapper.glTexSubImage1D object at 0x26bbbd8>
glTexSubImage1Ds = <OpenGL.wrapper.glTexSubImage1D object at 0x26bd320>
glTexSubImage1Dub = <OpenGL.wrapper.glTexSubImage1D object at 0x26bda28>
glTexSubImage1Dui = <OpenGL.wrapper.glTexSubImage1D object at 0x26c0170>
glTexSubImage1Dus = <OpenGL.wrapper.glTexSubImage1D object at 0x26c0878>
glTexSubImage2D = <OpenGL.wrapper.glTexSubImage2D object at 0x26b73f8>
glTexSubImage2Db = <OpenGL.wrapper.glTexSubImage2D object at 0x26b7ef0>
glTexSubImage2Df = <OpenGL.wrapper.glTexSubImage2D object at 0x26bb638>
glTexSubImage2Di = <OpenGL.wrapper.glTexSubImage2D object at 0x26bbd40>
glTexSubImage2Ds = <OpenGL.wrapper.glTexSubImage2D object at 0x26bd488>
glTexSubImage2Dub = <OpenGL.wrapper.glTexSubImage2D object at 0x26bdb90>
glTexSubImage2Dui = <OpenGL.wrapper.glTexSubImage2D object at 0x26c02d8>
glTexSubImage2Dus = <OpenGL.wrapper.glTexSubImage2D object at 0x26c09e0>