beastframebuffer.h

Go to the documentation of this file.

/*
Copyright 2014 Autodesk, Inc.  All rights reserved.
Use of this software is subject to the terms of the Autodesk license agreement
provided at the time of installation or download, or which otherwise 
accompanies this software in either electronic or hard copy form.
*/


#ifndef BEASTFRAMEBUFFER_H
#define BEASTFRAMEBUFFER_H

#include "beastapitypes.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

enum ILBChannelSelection {
    ILB_CS_R = 0, 
    ILB_CS_G, 
    ILB_CS_B, 
    ILB_CS_A, 
    ILB_CS_Z, 
    ILB_CS_RGB, 
    ILB_CS_RGBA, 
    ILB_CS_RGBZ, 
    ILB_CS_RGBAZ, 
    ILB_CS_ALL, 
};

ILB_DLL_FUNCTION ILBStatus ILBGetChannelCount(ILBFramebufferHandle fb, int32* channels);

ILB_DLL_FUNCTION ILBStatus ILBGetChannelName(ILBFramebufferHandle fb, 
                                             int32 index,
                                             ILBStringHandle* name);

ILB_DLL_FUNCTION ILBStatus ILBGetResolution(ILBFramebufferHandle fb, 
                                            int32* width,
                                            int32* height);

ILB_DLL_FUNCTION ILBStatus ILBGetFramebufferTarget(ILBFramebufferHandle fb, ILBTargetHandle* target);

ILB_DLL_FUNCTION ILBStatus ILBGetFramebufferTargetEntity(ILBFramebufferHandle fb, ILBTargetEntityHandle* entity);

ILB_DLL_FUNCTION ILBStatus ILBGetFramebufferPass(ILBFramebufferHandle fb, ILBRenderPassHandle* pass);

ILB_DLL_FUNCTION ILBStatus ILBReadRegionHDR(ILBFramebufferHandle fb, 
                                            int32 minX,
                                            int32 minY,
                                            int32 maxX,
                                            int32 maxY,
                                            ILBChannelSelection channels,
                                            float* target);

ILB_DLL_FUNCTION ILBStatus ILBReadRegionLDR(ILBFramebufferHandle fb, 
                                            int32 minX,
                                            int32 minY,
                                            int32 maxX,
                                            int32 maxY,
                                            ILBChannelSelection channels,
                                            float gamma,
                                            unsigned char* target);


ILB_DLL_FUNCTION ILBStatus ILBDestroyFramebuffer(ILBFramebufferHandle fb);

#ifdef __cplusplus
}
#endif // __cplusplus

#endif // BEASTFRAMEBUFFER_H