VuoGlPool.h File Reference

Description

VuoGlPool interface.

Copyright

Copyright © 2012–2014 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

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.
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.

Enumeration Type Documentation

enum VuoGlPoolType

Types of OpenGL objects supported by Vuo's GL object pool.

Function Documentation

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.

Todo:

https://b33p.net/kosada/node/6901 The returned buffer's storage ~~is~~ will be preallocated (so the caller can efficiently upload data using glBufferSubData),

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.)

Todo:

remove VRAM check after https://b33p.net/kosada/node/6909

Todo:

https://b33p.net/kosada/node/6901

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:

• wrapping: clamp to border
• filtering: linear

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.)

Todo:

remove VRAM check after https://b33p.net/kosada/node/6909