include/VR3Lib.h

Go to the documentation of this file.

// Copyright (C) 2010  Daniele Giannetti
//
// This file is part of VR3Lib.
// The VR3Lib is free software, but is distributed in the static precompiled 
// version as it is NOT open source. The VR3Lib may be used in any virtual 
// reality application free of charge, but it must be clearly stated that this 
// library is used in the application EULA and distribution license 
// (for both free and proprietary applications).

#ifndef __VR3LIB_H__
#define __VR3LIB_H__

// VR3Lib configuration
#include <VR3Config.h>

// OpenGL includes
#include <GL/glew.h>


struct VR3Globals {
    static bool VR3InitFlag;
    static GLint max_tex_combined_units;
    static GLint max_fbo_images;
    static GLint max_gemoetry_out_components;
    static GLint max_shadow_sources;
    static GLfloat max_anisotropy;

private:   
    VR3Globals();
};

//-------------- Global Initialization and Shutdown Functions ----------------//




void VR3Init();


void VR3Deinit();


//----------------------------- OpenGL Version -------------------------------//



#define VR3_GL_VERSION_MAJOR "3"

#define VR3_GL_VERSION_MINOR "3"
// (we are using OpenGL 3.3)




#define VR3_GLSL_VERSION_MAJOR "3"

#define VR3_GLSL_VERSION_MINOR "30"
// (we are using GLSL 3.30)


//---------------------------- Scene Begin flags -----------------------------//




#define VR3BEGFL_KEEPCOLORS 0x0001


#define VR3BEGFL_KEEPLIGHTS 0x0002


#define VR3BEGFL_KEEPMATRICES 0x0004


#define VR3BEGFL_KEEPSHADOWMAPS 0x0008

#if (defined(_WIN32) || defined(_WIN64)) && !defined(VR3CONF_NOPHYSICS)


#define VR3BEGFL_KEEPPHYSICS 0x0010

#endif


//---------------------- Objects and Meshes Draw Flags -----------------------//




#define VR3DRAWFL_SHADOWMAP 0x0001


#define VR3DRAWFL_RECEIVESHADOWS 0x0002

#if (defined(_WIN32) || defined(_WIN64)) && !defined(VR3CONF_NOPHYSICS)


#define VR3DRAWFL_NOSIMULATE 0x0004

#endif


//------------- Scene Features (used with Enable() and Disable()) ------------//



#define VR3SC_LIGHT 0


#define VR3SC_VF_CULLING 1


#define VR3SC_FACE_CULLING 2


//------------------------------ Camera Modes --------------------------------//



#define VR3CAM_FREE 0

#define VR3CAM_LOOKAT 1


//----------------------------- Light Constants ------------------------------//



#define VR3LIGHT_AMBIENT 0

#define VR3LIGHT_DIFFUSE 1

#define VR3LIGHT_SPECULAR 2


//------------------------ Environment Mapping Modes -------------------------//

#define VR3EM_NONE 0x0000

#define VR3EM_DIFFUSE 0x0001

#define VR3EM_SPECULAR 0x0002

#define VR3EM_FULL 0x0003

//----------------------------- Scene Constants ------------------------------//



#define VR3SC_NUM_CAMERAS 8

#define VR3SC_NUM_LIGHTS 16

#define VR3SC_DEF_ZNEAR 0.1f

#define VR3SC_DEF_ZFAR 1000.0f


//----------------------------- Object Constants -----------------------------//



#define VR3OBJ_NUM_LODS 10


//------------------------------ Mesh Constants ------------------------------//



#define VR3MESH_MAX_VER_ATTRIBS 6
    
#define VR3MESH_VER_POS_INDEX 0

#define VR3MESH_NORM_INDEX 1

#define VR3MESH_DIFF_COORD_INDEX 2

#define VR3MESH_LIGHT_COORD_INDEX 3

#define VR3MESH_NORM_COORD_INDEX 4

#define VR3MESH_DISP_COORD_INDEX 5

#define VR3MESH_DEF_BI 0.0f

#define VR3MESH_DEF_SC 1.0f

#define VR3MESH_DEF_TF 4

#define VR3MESH_MIN_TF 2


//--------------------------- Background Constants ---------------------------//



#define VR3BG_VER_POS_INDEX 0


//------------------------------ Text Constants ------------------------------//

// windows only
#if defined(_WIN32) || defined(_WIN64)



#define VR3TEXT_VER_POS_INDEX 0

#define VR3TEXT_DEF_RESY 32

#define VR3TEXT_DEF_FONT "Times New Roman"

#define VR3TEXT_DEF_CHARSET ANSI_CHARSET

#define VR3TEXT_ZDISPLACEMENT 0.0001f


#endif

//------------------------- Texture Units Constants --------------------------//


#define VR3TEX_RESERVED_UNITS 6

#define VR3TEXUNIT_DIFFUSE GL_TEXTURE0

#define VR3TEXUNIT_LIGHT GL_TEXTURE1

#define VR3TEXUNIT_NORMAL GL_TEXTURE2

#define VR3TEXUNIT_DISPLACEMENT GL_TEXTURE3

#define VR3TEXUNIT_ENVDIFF GL_TEXTURE4

#define VR3TEXUNIT_ENVSPEC GL_TEXTURE5

#define VR3TEXUNIT_BACKGROUND GL_TEXTURE0

#define VR3TEXUNIT_BASE_SHADOW (GL_TEXTURE0+VR3TEX_RESERVED_UNITS)

#define VR3TEXUNIT_BLUR GL_TEXTURE0

#define VR3TEXUNIT_TEXT GL_TEXTURE0

// More texture image units are reserved for 
// shadow maps or external shader textures (to implementation limit)


//------------------------------ Texture Types -------------------------------//



#define VR3TEX_2D GL_TEXTURE_2D

#define VR3TEX_CUBE_MAP GL_TEXTURE_CUBE_MAP


//------------------------- Material Texture Types ---------------------------//



#define VR3TEX_DIFFUSE 0

#define VR3TEX_LIGHT 1

#define VR3TEX_NORMAL 2

#define VR3TEX_DISPLACEMENT 3


//--------------------------- Material Constants -----------------------------//

#define VR3MAT_NOSUB -2

//------------------------ Shadow Mapping Constants --------------------------//



#define VR3SDOW_NUM_SOURCES 16

#define VR3SDOW_DEF_DEPTHSCALE 40.0f

#define VR3SDOW_DEF_MINVARIANCE 0.00001f

#define VR3SDOW_DEF_INTENSITY 0.4f

#define VR3SDOW_DEF_BLEEDREDUCTION 0.0f

#define VR3SDOW_DEF_FILTERSIZE 3


#define VR3SDOW_MAX_DEPTHSCALE 40.0f

#define VR3SDOW_MAX_FILTERSIZE 10

#define VR3SDOW_MIN_FILTERSIZE 1


//------- Shadow Controller Features (used with Enable() and Disable()--------//



#define VR3SDOW_SOURCE 0


#define VR3SDOW_VF_CULLING 1


#define VR3SDOW_FACE_CULLING 2


#define VR3SDOW_SOURCE_CULLING 3


//------------------------- Shadow Controller Modes --------------------------//



#define VR3SDOWCTRL_AUTOMATIC 0

#define VR3SDOWCTRL_MANUAL 1


//----------------------- Shadow Controller Constants ------------------------//



#define VR3SDOWCTRL_BLUR_VER_POS_INDEX 0


//----------------------- User Defined FBOs constants ------------------------//



#define VR3FBO_MAX_IMAGES 16


//------------------ Standard Shaders Uniform Identifiers --------------------//


#define VR3_NUM_STD_UNIFORMS 39

// -------- Transformation and viewing uniforms -------- //

#define VR3UNI_transformMatrix 0


#define VR3UNI_eyePosObj 1

#define VR3UNI_modelMatrix 2

#define VR3UNI_viewMatrix 3

#define VR3UNI_projMatrix 4

#define VR3UNI_normalMatrix 5

// -------- Material uniforms -------- //

#define VR3UNI_matEmission 6

#define VR3UNI_matAmbient 7

#define VR3UNI_matDiffuse 8

#define VR3UNI_matSpecular 9

#define VR3UNI_matOpacity 10

#define VR3UNI_matShininess 11

// -------- Lights uniforms -------- //

#define VR3UNI_lightAmbient 12

#define VR3UNI_lightDiffuse 13

#define VR3UNI_lightSpecular 14

#define VR3UNI_lightPosObj 15

#define VR3UNI_numActiveLights 16

#define VR3UNI_lightPos 17

// -------- Texture mapping uniforms -------- //

#define VR3UNI_diffMatrix 18

#define VR3UNI_diffFlag 19

#define VR3UNI_lightMatrix 20

#define VR3UNI_lightFlag 21

#define VR3UNI_normMatrix 22

#define VR3UNI_normFlag 23

#define VR3UNI_dispMatrix 24

#define VR3UNI_dispFlag 25

#define VR3UNI_dispBI 26

#define VR3UNI_dispSC 27

#define VR3UNI_dispTF 28

// -------- Environment mapping uniforms -------- //

#define VR3UNI_envMode 29

// -------- Shadow mapping uniforms -------- //

#define VR3UNI_shaNumActiveSources 30

#define VR3UNI_shaModelView 31

#define VR3UNI_shaProj 32

#define VR3UNI_shaMinVariance 33

#define VR3UNI_shaIntensity 34

#define VR3UNI_shaBleedRedFactor 35

#define VR3UNI_shaDepthScale 36

#define VR3UNI_shazFar 37

#define VR3UNI_shazNear 38


//------------------ Background Shaders Uniform Identifiers --------------------//


#define VR3_NUM_BG_UNIFORMS 1

#define VR3UNI_bg_transformMatrix 0


//----------------- Shadow Map Shader Uniforms Identifiers -------------------//


#define VR3_NUM_SHAD_UNIFORMS 5

#define VR3UNI_shad_modelViewMatrix 0

#define VR3UNI_shad_projMatrix 1

#define VR3UNI_shad_depthScale 2

#define VR3UNI_shad_zFar 3

#define VR3UNI_shad_zNear 4


//----------------- Blurring Shaders Uniforms Identifiers --------------------//


#define VR3_NUM_BLUR_UNIFORMS 2


#define VR3UNI_blur_texSize 0

#define VR3UNI_blur_filterSize 1


//-------------------- Text Shader Uniforms Identifiers ----------------------//

// windows only
#if defined(_WIN32) || defined(_WIN64)


#define VR3_NUM_TEXT_UNIFORMS 3

#define VR3UNI_text_transformMatrix 0

#define VR3UNI_text_offset 1

#define VR3UNI_text_color 2


#endif

//----------------------- Standard Shaders Constants -------------------------//



#define VR3SH_GS_COMPONENTS_PER_VERTEX_DIFF 11

#define VR3SH_GS_COMPONENTS_PER_VERTEX_NODIFF 9


//--------------------- Notification Service Constants -----------------------//



#define VR3_MAX_NOTIFICATION_LENGTH 256


//----------------------- Physics Subsystem Constants ------------------------//

// windows only
#if (defined(_WIN32) || defined(_WIN64)) && !defined(VR3CONF_NOPHYSICS)

//-------------------- Objects Physics Simulation Modes ----------------------//



#define VR3PHYMESH_DYNAMIC 0

#define VR3PHYMESH_STATIC 1

#define VR3PHYMESH_KINEMATIC 2





#define VR3PHY_DYN_SKINDIVIDER 200.0f


#define VR3PHY_STA_SKINDIVIDER 1000.0f


#define VR3PHY_PROJDISTDIVIDER 1.0f

#define VR3PHY_DEF_SKINWIDTH 0.1f

#define VR3PHY_DEF_GRAVITY 0.0f,-9.80665f,0.0f


#define VR3PHYSIM_DEF_ITERNUM 10


#define VR3PHYSIM_DEF_TIMESTEP (1.0f/120.0f)


#define VR3PHYSIM_DEF_MAXSTEPS 8


//------------------------- Physics Simulator Modes --------------------------//



#define VR3PHYSIM_AUTOMATIC 0

#define VR3PHYSIM_MANUAL 1


#endif // windows only

//---------------------------- Other constants -------------------------------//



#define VR3_INT_STRING_LENGTH 16


//----------------------------- Utility Macros -------------------------------//



#define STRINGIFY2(x) #x

#define STRINGIFY(x) STRINGIFY2(x)

// if we have 
// #define NUM_SOMETHING 22
// then
// STRINGIFY(NUM_SOMETHING) expands to STRINGIFY2(22)
// STRINGIFY2(22) expands to "22"


#endif