VuoImage.h

Go to the documentation of this file.

 
#ifndef VuoImage_h
#define VuoImage_h
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef DISPATCH_RETURNS_RETAINED_BLOCK
    #define DISPATCH_RETURNS_RETAINED_BLOCK
#endif
#include "VuoMacOSSDKWorkaround.h"
#include <dispatch/dispatch.h>
 
#include "VuoBoolean.h"
#include "VuoColor.h"
#include "VuoGlContext.h"
#include "VuoImageColorDepth.h"
#include "VuoImageWrapMode.h"
#include "VuoPoint2d.h"
#include "VuoRectangle.h"
 
typedef struct _VuoImage *VuoImage;
 
#define VuoImage_SUPPORTS_COMPARISON  
#define VuoImage_OVERRIDES_INTERPROCESS_SERIALIZATION  
 
typedef void (*VuoImage_freeCallback)(VuoImage imageToFree);
 
struct _VuoImage
{
    // GPU image
    unsigned int glTextureName; 
    unsigned int glInternalFormat;  
    unsigned long int glTextureTarget;  
 
    // Common
    unsigned long int pixelsWide; 
    unsigned long int pixelsHigh; 
    float scaleFactor;            
 
    void *freeCallbackContext;  
 
    // CPU image
    dispatch_once_t cpuQueueInitialized;    
    dispatch_queue_t cpuQueue;              
    struct json_object *cpuData;            
};
 
typedef enum {
    VuoImageSampling_Nearest,
    VuoImageSampling_Linear,
} VuoImageSamplingMode;
 
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) __attribute__((nonnull(5)));
VuoImage VuoImage_makeClientOwnedGlTextureRectangle(unsigned int glTextureName, unsigned int glInternalFormat, unsigned long int pixelsWide, unsigned long int pixelsHigh, VuoImage_freeCallback freeCallback, void *freeCallbackContext) __attribute__((nonnull(5)));
VuoImage VuoImage_makeFromBuffer(const void *pixels, unsigned int format, unsigned int pixelsWide, unsigned int pixelsHigh, VuoImageColorDepth colorDepth, void (^freeCallback)(void *pixels)) __attribute__((nonnull(1)));
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))) __attribute__((nonnull(7)));
VuoImage VuoImage_makeColorImage(VuoColor color, unsigned int pixelsWide, unsigned int pixelsHigh);
VuoImage VuoImage_makeCopy(VuoImage image, bool flip, unsigned int forcePixelsWide, unsigned int forcePixelsHigh, bool forceAlpha);
VuoImage VuoImage_makeGlTextureRectangleCopy(VuoImage image);
const unsigned char *VuoImage_getBuffer(VuoImage image, unsigned int requestedFormat);
 
VuoImageWrapMode VuoImage_getWrapMode(VuoImage image);
void VuoImage_setWrapMode(VuoImage image, VuoImageWrapMode wrapMode);
 
void VuoImage_setSamplingMode(VuoImage image, VuoImageSamplingMode samplingMode);
 
VuoImage VuoImage_mapColors(VuoImage image, VuoList_VuoColor colors, VuoReal filterOpacity);
 
bool VuoImage_areEqual(const VuoImage a, const VuoImage b);
bool VuoImage_areEqualWithinTolerance(const VuoImage a, const VuoImage b, const unsigned char tolerance);
bool VuoImage_isLessThan(const VuoImage a, const VuoImage b);
bool VuoImage_isEmpty(const VuoImage image);
bool VuoImage_isBlackOrTransparent(const VuoImage image, const unsigned char tolerance);
bool VuoImage_isPopulated(const VuoImage image);
 
VuoRectangle VuoImage_getRectangle(const VuoImage image);
VuoImageColorDepth VuoImage_getColorDepth(const VuoImage image);
 
VuoImage VuoImage_makeFromJson(struct json_object * js);
VuoImage VuoImage_makeFromJsonWithDimensions(struct json_object *js, unsigned int requestedPixelsWide, unsigned int requestedPixelsHigh) VuoWarnUnusedResult;
GLuint VuoImage_resolveInterprocessJsonUsingTextureProvider(struct json_object *js, GLuint (^provider)(unsigned int pixelsWide, unsigned int pixelsHigh), unsigned int *outputPixelsWide, unsigned int *outputPixelsHigh, void *outputIOSurface) VuoWarnUnusedResult;
bool VuoImage_resolveInterprocessJsonUsingClientTexture(struct json_object *js, GLuint textureName, unsigned int pixelsWide, unsigned int pixelsHigh, void *outputIOSurface) VuoWarnUnusedResult;
bool VuoImage_resolveInterprocessJsonOntoFramebuffer(struct json_object *js, VuoGlContext context, bool flip, bool stretch) VuoWarnUnusedResult;
struct json_object * VuoImage_getJson(const VuoImage value);
 
struct json_object * VuoImage_getInterprocessJson(const VuoImage value);
 
char * VuoImage_getSummary(const VuoImage value);
 
 
char * VuoImage_getString(const VuoImage value);
char * VuoImage_getInterprocessString(const VuoImage value);
void VuoImage_retain(VuoImage value);
void VuoImage_release(VuoImage value);
 
#ifdef __cplusplus
}
#endif
 
#endif