Vuo
0.6.0
|
VuoGlPool interface.
Typedefs | |
typedef void * | VuoIoSurface |
A Mac OS X IOSurface. | |
Enumerations | |
enum | VuoGlPoolType { VuoGlPool_ArrayBuffer, VuoGlPool_ElementArrayBuffer } |
Types of OpenGL objects supported by Vuo's GL object pool. More... | |
Functions | |
GLuint | VuoGlPool_use (VuoGlContext glContext, VuoGlPoolType type, unsigned long size) |
Returns an OpenGL Buffer Object of type type . | |
void | VuoGlPool_disuse (VuoGlContext glContext, VuoGlPoolType type, unsigned long size, GLuint name) |
Indicates that the caller is done using the OpenGL object name of type type . | |
GLuint | VuoGlTexturePool_use (VuoGlContext glContext, GLenum internalformat, unsigned short width, unsigned short height, GLenum format) |
Returns an OpenGL texture. | |
void | VuoGlTexture_retain (GLuint glTextureName) |
Increments the reference count for glTextureName . | |
void | VuoGlTexture_release (GLenum internalformat, unsigned short width, unsigned short height, GLuint glTextureName) |
Decrements the reference count for glTextureName . | |
VuoIoSurface | VuoIoSurfacePool_use (VuoGlContext glContext, unsigned short pixelsWide, unsigned short pixelsHigh, GLuint *outputTexture) |
Returns an IOSurface (backed by outputTexture ) with the specified dimensions. | |
uint32_t | VuoIoSurfacePool_getId (VuoIoSurface ioSurface) |
Returns the IOSurface's interprocess ID. | |
void | VuoIoSurfacePool_disuse (VuoGlContext glContext, unsigned short pixelsWide, unsigned short pixelsHigh, VuoIoSurface ioSurface, GLuint texture) |
Called by the sending end of an IOSurface texture transfer to indicate that it is finished using the IOSurface's texture. | |
void | VuoIoSurfacePool_signal (VuoIoSurface ioSurface) |
Called by the receiving end of an IOSurface texture transfer to indicate that it is finished using the IOSurface's texture. | |
GLuint | VuoGlShader_use (VuoGlContext glContext, GLenum type, const char *source) |
Returns an OpenGL Shader Object representing the specified source . | |
const char * | VuoGl_stringForConstant (GLenum constant) |
Returns a string for the specified OpenGL constant. | |
typedef void* VuoIoSurface |
A Mac OS X IOSurface.
enum VuoGlPoolType |
Types of OpenGL objects supported by Vuo's GL object pool.
const char* VuoGl_stringForConstant | ( | GLenum | constant | ) |
Returns a string for the specified OpenGL constant.
Don't free the string returned by this function.
void VuoGlPool_disuse | ( | VuoGlContext | glContext, |
VuoGlPoolType | type, | ||
unsigned long | size, | ||
GLuint | name | ||
) |
Indicates that the caller is done using the OpenGL object name
of type type
.
The object is returned to the pool, so other callers can use it (which is more efficient than deleting and re-generating objects).
This function may be called from any thread. (However, the caller is responsible for ensuring that the GL context is not used simultaneously on multiple threads.)
GLuint VuoGlPool_use | ( | VuoGlContext | glContext, |
VuoGlPoolType | type, | ||
unsigned long | size | ||
) |
Returns an OpenGL Buffer Object of type type
.
If an existing, unused buffer of the specified type
and size
is available, it is returned. Otherwise, a new buffer is created.
This function may be called from any thread. (However, the caller is responsible for ensuring that the GL context is not used simultaneously on multiple threads.)
GLuint VuoGlShader_use | ( | VuoGlContext | glContext, |
GLenum | type, | ||
const char * | source | ||
) |
Returns an OpenGL Shader Object representing the specified source
.
To improve performance, this function keeps a cache of precompiled shaders. If a precompiled shader exists for the specified source
, that shader is returned. Otherwise, source
is passed off to OpenGL to be compiled.
void VuoGlTexture_release | ( | GLenum | internalformat, |
unsigned short | width, | ||
unsigned short | height, | ||
GLuint | glTextureName | ||
) |
Decrements the reference count for glTextureName
.
This function may be called from any thread.
void VuoGlTexture_retain | ( | GLuint | glTextureName | ) |
Increments the reference count for glTextureName
.
This function may be called from any thread.
GLuint VuoGlTexturePool_use | ( | VuoGlContext | glContext, |
GLenum | internalformat, | ||
unsigned short | width, | ||
unsigned short | height, | ||
GLenum | format | ||
) |
Returns an OpenGL texture.
If an existing, unused texture matching the specified internalformat
, width
, and height
is available, it is returned. Otherwise, a new texture is created.
The returned texture's storage is preallocated (so the caller can efficiently upload data using glTexSubImage2D), and its texturing properties are set to the defaults:
See glTexImage2D for information about internalformat
and format
.
This function may be called from any thread. (However, the caller is responsible for ensuring that the GL context is not used simultaneously on multiple threads.)
void VuoIoSurfacePool_disuse | ( | VuoGlContext | glContext, |
unsigned short | pixelsWide, | ||
unsigned short | pixelsHigh, | ||
VuoIoSurface | ioSurface, | ||
GLuint | texture | ||
) |
Called by the sending end of an IOSurface texture transfer to indicate that it is finished using the IOSurface's texture.
This enables the IOSurface to be reused for another texture transfer (once the receiving end indicates it is done with it, via VuoIoSurfacePool_signal()).
uint32_t VuoIoSurfacePool_getId | ( | VuoIoSurface | ioSurface | ) |
Returns the IOSurface's interprocess ID.
void VuoIoSurfacePool_signal | ( | VuoIoSurface | ioSurface | ) |
Called by the receiving end of an IOSurface texture transfer to indicate that it is finished using the IOSurface's texture.
This enables the sender to reuse the IOSurface for another texture transfer.
VuoIoSurface VuoIoSurfacePool_use | ( | VuoGlContext | glContext, |
unsigned short | pixelsWide, | ||
unsigned short | pixelsHigh, | ||
GLuint * | outputTexture | ||
) |
Returns an IOSurface (backed by outputTexture
) with the specified dimensions.
Uses an IOSurface from the pool, if possible. If not, creates a new IOSurface.