VuoImage.h File Reference

Description

VuoImage C type definition.

Copyright

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

Definition in file VuoImage.h.

Go to the source code of this file.

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. More...
#define	VuoImage_SUPPORTS_COMPARISON
	This type has _areEqual() and _isLessThan() functions. More...
#define	VuoImage_REQUIRES_INTERPROCESS_JSON
	This type has a _getInterprocessJson() function. More...

Typedefs
typedef struct _VuoImage *	VuoImage
	An image residing in GPU memory (GL Texture Object). More...
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). More...

Functions
VuoImage	VuoImage_make (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh)
VuoImage	VuoImage_makeClientOwned (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh, VuoImage_freeCallback freeCallback, void *freeCallbackContext)
VuoImage	VuoImage_makeClientOwnedGlTextureRectangle (unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh, VuoImage_freeCallback freeCallback, void *freeCallbackContext)
VuoImage	VuoImage_makeFromBuffer (const void *pixels, unsigned int format, unsigned int pixelsWide, unsigned int pixelsHigh, VuoImageColorDepth colorDepth, void(^freeCallback)(void *pixels))
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). More...
VuoImage	VuoImage_makeColorImage (VuoColor color, unsigned int pixelsWide, unsigned int pixelsHigh)
	Makes a solid-color image. More...
VuoImage	VuoImage_makeCopy (VuoImage image, bool flip, unsigned int forcePixelsWide, unsigned int forcePixelsHigh, bool forceAlpha)
	Returns a new texture copy of the passed image. More...
VuoImage	VuoImage_makeGlTextureRectangleCopy (VuoImage image)
	Copies image to a new GL_TEXTURE_RECTANGLE_ARB texture. More...
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. More...
VuoImageWrapMode	VuoImage_getWrapMode (VuoImage image)
	Returns the image's wrap mode. More...
void	VuoImage_setWrapMode (VuoImage image, VuoImageWrapMode wrapMode)
	Changes the image's wrap mode. More...
VuoImage	VuoImage_mapColors (VuoImage image, VuoList_VuoColor colors, VuoReal filterOpacity)
	Returns a color-mapped copy of image. More...
bool	VuoImage_areEqual (const VuoImage a, const VuoImage b)
	Returns true if both images have the same dimensions and the same RGBA pixel data. More...
bool	VuoImage_isLessThan (const VuoImage a, const VuoImage b)
	Returns true if the size of a is less than the size of b. More...
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. More...
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. More...
VuoImageColorDepth	VuoImage_getColorDepth (const VuoImage image)
	Returns the color depth of the image. More...
VuoImage	VuoImage_makeFromJson (json_object *js)
VuoImage	VuoImage_makeFromJsonWithDimensions (struct json_object *js, unsigned int requestedPixelsWide, unsigned int requestedPixelsHigh)
GLuint	VuoImage_resolveInterprocessJsonUsingTextureProvider (struct json_object *js, GLuint(^provider)(unsigned int pixelsWide, unsigned int pixelsHigh), unsigned int *outputPixelsWide, unsigned int *outputPixelsHigh, void *outputIOSurface) VuoWarnUnusedResult
	Decodes the JSON object js onto a host-provided OpenGL texture's GL_TEXTURE_RECTANGLE_ARB target. More...
bool	VuoImage_resolveInterprocessJsonUsingClientTexture (struct json_object *js, GLuint textureName, unsigned int pixelsWide, unsigned int pixelsHigh, void *outputIOSurface) VuoWarnUnusedResult
	Decodes the JSON object js onto a host-provided OpenGL texture's GL_TEXTURE_RECTANGLE_ARB target. More...
bool	VuoImage_resolveInterprocessJsonOntoFramebuffer (struct json_object *js, VuoGlContext context, bool flip) VuoWarnUnusedResult
	Decodes the JSON object js onto the framebuffer of a host-provided OpenGL context. More...
json_object *	VuoImage_getJson (const VuoImage value)
json_object *	VuoImage_getInterprocessJson (const VuoImage value)
char *	VuoImage_getSummary (const VuoImage value)
VuoImage	VuoImage_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoImage_getString (const VuoImage value)
	Automatically generated function. More...
char *	VuoImage_getInterprocessString (const VuoImage value)
	Automatically generated function. More...
void	VuoImage_retain (VuoImage value)
	Automatically generated function. More...
void	VuoImage_release (VuoImage value)
	Automatically generated function. More...

Macro Definition Documentation

DISPATCH_RETURNS_RETAINED_BLOCK

#define DISPATCH_RETURNS_RETAINED_BLOCK

Disable DISPATCH_RETURNS_RETAINED_BLOCK, which emits warnings on Mac OS 10.10.

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

Definition at line 19 of file VuoImage.h.