Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Macros | Typedefs | Functions
VuoImage.h File Reference

Description

VuoImage C type definition.

Classes

struct  _VuoImage
 An image residing in GPU memory (GL Texture Object), with an optional CPU copy. More...
 

Macros

#define DISPATCH_RETURNS_RETAINED_BLOCK
 Disable DISPATCH_RETURNS_RETAINED_BLOCK, which emits warnings on Mac OS 10.10.
 

Typedefs

typedef struct _VuoImageVuoImage
 An image residing in GPU memory (GL Texture Object).
 
typedef void(* VuoImage_freeCallback )(VuoImage imageToFree)
 A callback to be implemented if non-Vuo code needs to retain ownership of the GL texture (instead of the default behavior where VuoImage takes ownership of the texture).
 

Functions

VuoImage VuoImage_make (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh)
 Returns a new VuoImage structure representing the specified glTextureName.
 
VuoImage VuoImage_makeClientOwned (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh, VuoImage_freeCallback freeCallback, void *freeCallbackContext)
 Returns a new VuoImage structure representing the specified glTextureName.
 
VuoImage VuoImage_makeClientOwnedGlTextureRectangle (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh, VuoImage_freeCallback freeCallback, void *freeCallbackContext)
 Returns a new VuoImage structure representing the specified glTextureName.
 
VuoImage VuoImage_makeFromBuffer (const void *pixels, unsigned int format, unsigned int pixelsWide, unsigned int pixelsHigh, VuoImageColorDepth colorDepth, void(^freeCallback)(void *pixels))
 Uploads the specified pixel data to the GPU and returns a new VuoImage referencing it.
 
VuoImage VuoImage_makeFromBufferWithStride (const void *pixels, unsigned int format, unsigned int pixelsWide, unsigned int pixelsHigh, unsigned int bytesPerRow, VuoImageColorDepth colorDepth, void(^freeCallback)(void *pixels)) __attribute__((nonnull(1)))
 Same as VuoImage_makeFromBuffer, but accepts a nonstandard stride (bytesPerRow).
 
VuoImage VuoImage_makeColorImage (VuoColor color, unsigned int pixelsWide, unsigned int pixelsHigh)
 Makes a solid-color image.
 
VuoImage VuoImage_makeCopy (VuoImage image, bool flip)
 Returns a new texture copy of the passed image.
 
VuoImage VuoImage_makeGlTextureRectangleCopy (VuoImage image)
 Copies image to a new GL_TEXTURE_RECTANGLE_ARB texture.
 
VuoImage VuoImage_makeFromContextFramebuffer (VuoGlContext context)
 Returns an image with the contents of the context's framebuffer.
 
const unsigned char * VuoImage_getBuffer (VuoImage image, unsigned int requestedFormat)
 Downloads the specified image's pixel data from the GPU to the CPU (or returns it from a cache), and returns the CPU memory buffer.
 
void VuoImage_setWrapMode (VuoImage image, VuoImageWrapMode wrapMode)
 Changes the image's wrap mode.
 
VuoImage VuoImage_mapColors (VuoImage image, VuoList_VuoColor colors, VuoReal filterOpacity)
 Returns a color-mapped copy of image.
 
bool VuoImage_areEqual (const VuoImage a, const VuoImage b)
 Returns true if both images have the same dimensions and the same RGBA pixel data.
 
bool VuoImage_areEqualWithinTolerance (const VuoImage a, const VuoImage b, const unsigned char tolerance)
 Like VuoImage_areEqual(), but permits color channel values to differ by up to tolerance.
 
bool VuoImage_isEmpty (const VuoImage image)
 
bool VuoImage_isPopulated (const VuoImage image)
 
VuoRectangle VuoImage_getRectangle (const VuoImage image)
 Returns a rectangle (in Vuo Coordinates) at the origin, with width 2 and height matching the image's aspect ratio.
 
VuoImageColorDepth VuoImage_getColorDepth (const VuoImage image)
 Returns the color depth of the image.
 
VuoImage VuoImage_makeFromJson (json_object *js)
 Decodes the JSON object js to create a new value.
 
GLuint VuoImage_resolveInterprocessJsonUsingTextureProvider (struct json_object *js, GLuint(^provider)(unsigned int pixelsWide, unsigned int pixelsHigh), unsigned int *outputPixelsWide, unsigned int *outputPixelsHigh, void *outputIOSurface)
 Decodes the JSON object js onto a host-provided OpenGL texture's GL_TEXTURE_RECTANGLE_ARB target.
 
json_objectVuoImage_getJson (const VuoImage value)
 Encodes value as a JSON object.
 
json_objectVuoImage_getInterprocessJson (const VuoImage value)
 Returns a JSON object containing an interprocess handle for the specified texture.
 
char * VuoImage_getSummary (const VuoImage value)
 A brief summary of the contents of this texture.
 
VuoImage VuoImage_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoImage_getString (const VuoImage value)
 Automatically generated function.
 
char * VuoImage_getInterprocessString (const VuoImage value)
 Automatically generated function.
 
void VuoImage_retain (VuoImage value)
 Automatically generated function.
 
void VuoImage_release (VuoImage value)
 Automatically generated function.
 

Macro Definition Documentation

#define DISPATCH_RETURNS_RETAINED_BLOCK

Disable DISPATCH_RETURNS_RETAINED_BLOCK, which emits warnings on Mac OS 10.10.

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