HDK: RU/RU_GPUFunctions.h Source File

00001 /*
00002  * PROPRIETARY INFORMATION.  This software is proprietary to
00003  * Side Effects Software Inc., and is not to be reproduced,
00004  * transmitted, or disclosed in any way without written permission.
00005  *
00006  * Produced by:
00007  *      Mark Alexander
00008  *      Side Effects
00009  *      123 Front Street West, Suite 1401
00010  *      Toronto, Ontario
00011  *      Canada   M5J 2M2
00012  *      416-504-9876
00013  *
00014  * NAME:        RU_GPUFunctions.h ( UT Library, C++)
00015  *
00016  * COMMENTS:
00017  *    This class contains a list of functions that return GPU code in
00018  *    in a UT_String for doing various things.
00019  *    
00020  *    The parameters and local variables for each are listed. Parameters
00021  *    must have valid values assigned, locals just need to be passed to the
00022  *    function (GLSL doesn't allow locals declared in functions - you have to
00023  *    pass them in).
00024  *
00025  *    If you wish to modify the code string, harden it first.
00026  *
00027  */
00028 #ifndef RU_GPUFunctions_h
00029 #define RU_GPUFunctions_h
00030 
00031 #include "RU_API.h"
00032 #include <PXL/PXL_LumFuncs.h>
00033 
00034 class UT_String;
00035 class TIL_TileList;
00036 class RE_OGLComputeGPU;
00037 
00038 // This adds the various tiles as single outputs to the shader, as
00039 // OUT_red(colorname.r); OUT_green(colorname.g); etc. It also registers them
00040 // as outputs with the RE_OGLComputeGPU engine.
00041 extern RU_API void RUsetOutput(RE_OGLComputeGPU &engine,
00042                                TIL_TileList *tiles,
00043                                const char *outname,
00044                                UT_String &shader);
00045 
00046 // vec4 texture_sample(...)
00047 //    Samples a texture in the area (x1,y1) - (x2,y2) from 'texture' and
00048 //    returns the filtered color.
00049 // Parameters:
00050 //   float x0  - sampling area
00051 //   float y0
00052 //   float x1
00053 //   float y1
00054 extern RU_API void RUgetTextureSampleGPU(const char *texture,
00055                                          int         vsize,
00056                                          UT_String &code);
00057 extern RU_API void RUgetTextureClamp(UT_String &code);
00058 extern RU_API void RUgetTextureBilinear(const char *texture,
00059                                         int vsize,
00060                                         UT_String &code);
00061 
00062 // vec3 toHSV(...)
00063 //    converts an RGB color to HSV
00064 // Parameters
00065 //   vec3   rgbcol  - RGB color to be converted
00066 extern RU_API void RUgetToHSVConvertGPU(UT_String &code);
00067 
00068 // vec3 toHSV(...)
00069 //    converts an HSV color to RGB
00070 // Parameters
00071 //   vec3   hsvcol  - HSV color to be converted
00072 extern RU_API void RUgetFromHSVConvertGPU(UT_String &code);
00073 
00074 
00075 // vec3 lambert_diffuse(vec3 N, vec3 L)
00076 // Parameters
00077 //   N - surface normal
00078 //   L - Light dir
00079 extern RU_API void RUgetDiffuseLambert(UT_String &code);
00080 
00081 // float oren_diffuse(vec3 N, vec3 L, vec3 I, float rough, ...)
00082 // Parameters
00083 //   N - surface normal
00084 //   L - Light dir
00085 //   I - Incident ray
00086 //   rough - roughness factor, from 0 (none) to 1
00087 extern RU_API void RUgetDiffuseOrenNayar(UT_String &code);
00088 
00089 // float phong_specular(vec3 N, vec3 L, vec3 I, float power)
00090 // Parameters:
00091 //   N - surface normal
00092 //   L - Light dir
00093 //   I - Incident ray
00094 //   power - phong exponent (higher = sharper highlight)
00095 extern RU_API void RUgetSpecularPhong(UT_String &code);
00096 
00097 // float blinn_specular(vec3 N, vec3 L, vec3 I, float rough, ...)
00098 // Parameters:
00099 //   N - surface normal
00100 //   L - Light dir
00101 //   I - Incident ray
00102 //   rough - roughness factor, from 0 (none) to 1
00103 extern RU_API void RUgetSpecularBlinn(UT_String &code);
00104 
00105 // Parm : int dropoff type. 0 = linear, 1 = ease in, 2 = ease out,
00106 // 3 = ease in/out, 4 = gaussian
00107 extern RU_API void RUgetDropoffFunc(UT_String &code);
00108 // returns a branchless version for the specific function.
00109 extern RU_API void RUgetSoftDropoff(int function, UT_String &code);
00110 
00111 // Parm: int lumfunc : 0 = standard lum, 1 = NTSC lum, 2 = max, 3 = min,
00112 //                     4 = average, 5 = red, 6 = green, 7 = blue.
00113 // Returns a float.
00114 extern RU_API void RUgetLuminanceFunc(UT_String &code);
00115 extern RU_API void RUgetLuminanceFunc(PXL_LumFunction f, UT_String &code);
00116 
00117 extern RU_API void RUgetFlatLightFrontend(UT_String &code);
00118 extern RU_API void RUgetBumpLightFrontend(UT_String &code,
00119                                           const char *bump_name);
00120 extern RU_API void RUget3DLightFrontend(UT_String &code,
00121                                         const char *point_name,
00122                                         const char *normal_name);
00123 
00124 extern RU_API void RUgetLightingBackend(UT_String &code,
00125                                         const char *color_name);
00126 extern RU_API void RUgetVolumetricLight(UT_String &code);
00127 
00128 extern RU_API void RUgetLightingMain(UT_String &code);
00129 
00130 extern RU_API void RUgetTransform(int vsize, const char *texture,
00131                                   UT_String &code);
00132 
00133 extern RU_API void RUgetTransformBlur(int vsize, const char *image,
00134                                       UT_String &code);
00135 extern RU_API void RUgetTransformDeformBlur(int vsize,
00136                                             const char *image,
00137                                             const char *prev,
00138                                             const char *next,
00139                                             UT_String &code);
00140 
00141 extern RU_API void RUgetFogMain(UT_String &code);
00142 extern RU_API void RUgetFogDistanceZ(const char *depth_name, UT_String &code);
00143 extern RU_API void RUgetFogDistanceP(const char *point_name, UT_String &code);
00144 extern RU_API void RUgetFogDistanceNone(UT_String &code);
00145 extern RU_API void RUgetFogColorConst(UT_String &code);
00146 extern RU_API void RUgetFogColorImage(const char *color_name,UT_String &code);
00147 extern RU_API void RUgetFogDensityConst(UT_String &code);
00148 extern RU_API void RUgetFogDensityImage(const char *alpha_name,UT_String &code);
00149 extern RU_API void RUgetFogConst(UT_String &code);
00150 extern RU_API void RUgetFogNoise(UT_String &code);
00151 
00152 extern RU_API void RUgetFogTypeFog(const char *color_name, UT_String &code);
00153 extern RU_API void RUgetFogTypeAdd(const char *color_name, UT_String &code);
00154 extern RU_API void RUgetFogTypeHeat(const char *color_name, UT_String &code);
00155 extern RU_API void RUgetFogTypeHaze(const char *color_name, UT_String &code);
00156 
00157 extern RU_API void RUgetZCompositeSimple(int vsize, UT_String &code);
00158 extern RU_API void RUgetZCompositeSuperSample(int vsize, UT_String &code);
00159 extern RU_API void RUgetZCompositeGeo(int vsize, UT_String &code);
00160 extern RU_API void RUgetZCompositeSuperSampleGeo(int vsize, UT_String &code);
00161 
00162 extern RU_API void RUgetEnvironmentMain(int vsize, UT_String &code);
00163 extern RU_API void RUgetEnvironmentBump(UT_String &code);
00164 extern RU_API void RUgetEnvironmentNormal(UT_String &code);
00165 extern RU_API void RUgetEnvironmentCubeDeep(UT_String &code);
00166 extern RU_API void RUgetEnvironmentCubeStrip(UT_String &code);
00167 extern RU_API void RUgetEnvironmentCubeCrossHorz(UT_String &code);
00168 extern RU_API void RUgetEnvironmentCubeCrossVert(UT_String &code);
00169 extern RU_API void RUgetEnvironmentLatLong(UT_String &code);
00170 
00171 extern RU_API void RUgetKeyMain(int vsize, const char *key, UT_String &code);
00172 extern RU_API void RUgetKeyMainSuperSample(int vsize, UT_String &code);
00173 extern RU_API void RUgetKeyMainSuperSampleSelf(int vsize, UT_String &code);
00174 extern RU_API void RUgetKeyLuma(int vsize, UT_String &code);
00175 extern RU_API void RUgetKeyChroma(int vsize, UT_String &code);
00176 
00177 extern RU_API void RUgetNoiseCop(UT_String &code);
00178 extern RU_API void RUgetPerlinNoise(UT_String &code);
00179 extern RU_API void RUgetSparseNoise(UT_String &code);
00180 extern RU_API void RUgetAlligatorNoise(UT_String &code);
00181 
00182 extern RU_API void RUgetDeform(const char *pname, int vsize, UT_String &code);
00183 extern RU_API void RUgetDeformMask(const char *pname, int vsize,
00184                                    UT_String &code);
00185 
00186 extern RU_API void RUgetConvolve(int vsize, UT_String &code);
00187 
00188 extern RU_API void RUgetExpand(int vsize, UT_String &code);
00189 extern RU_API void RUgetExpandLuma(int vsize, UT_String &code);
00190 extern RU_API void RUgetExpandPerPixel(int vsize, UT_String &code);
00191 extern RU_API void RUgetExpandLumaPerPixel(int vsize, UT_String &code);
00192 
00193 extern RU_API void RUgetBlurPerPixel(int vsize, UT_String &code);
00194 #endif