blender/source/gameengine/Rasterizer/RAS_IRasterizer.h

388 lines
9.5 KiB
C
Raw Normal View History

2002-10-12 11:37:38 +00:00
/**
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
2002-10-12 11:37:38 +00:00
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*/
#ifndef __RAS_IRASTERIZER
#define __RAS_IRASTERIZER
#ifdef WIN32
#pragma warning (disable:4786)
#endif
#include "STR_HashedString.h"
2002-10-12 11:37:38 +00:00
#include "MT_CmMatrix4x4.h"
#include "MT_Matrix4x4.h"
#include "RAS_TexVert.h"
#include <vector>
using namespace std;
2002-10-12 11:37:38 +00:00
class RAS_ICanvas;
class RAS_IPolyMaterial;
typedef vector<unsigned short> KX_IndexArray;
typedef vector<RAS_TexVert> KX_VertexArray;
typedef vector< KX_VertexArray* > vecVertexArray;
typedef vector< KX_IndexArray* > vecIndexArrays;
2002-10-12 11:37:38 +00:00
/**
* 3D rendering device context interface.
*/
class RAS_IRasterizer
{
public:
RAS_IRasterizer(RAS_ICanvas* canv){};
virtual ~RAS_IRasterizer(){};
/**
*/
2002-10-12 11:37:38 +00:00
enum {
RAS_RENDER_3DPOLYGON_TEXT = 16384
};
/**
* Drawing types
*/
enum DrawType {
2002-10-12 11:37:38 +00:00
KX_BOUNDINGBOX = 1,
KX_WIREFRAME,
KX_SOLID,
KX_SHADED,
KX_TEXTURED,
KX_SHADOW
};
/**
* Drawing modes
*/
enum DrawMode {
KX_MODE_LINES = 1,
KX_MODE_TRIANGLES,
KX_MODE_QUADS
2002-10-12 11:37:38 +00:00
};
/**
* Valid SetDepthMask parameters
*/
enum DepthMask {
2002-10-12 11:37:38 +00:00
KX_DEPTHMASK_ENABLED =1,
KX_DEPTHMASK_DISABLED
2002-10-12 11:37:38 +00:00
};
/**
*/
enum {
KX_TWOSIDE = 512,
KX_LINES = 32768
};
/**
* Stereo mode types
*/
enum StereoMode {
2002-10-12 11:37:38 +00:00
RAS_STEREO_NOSTEREO = 1,
RAS_STEREO_QUADBUFFERED,
RAS_STEREO_ABOVEBELOW,
RAS_STEREO_INTERLACED,
RAS_STEREO_ANAGLYPH,
RAS_STEREO_SIDEBYSIDE,
RAS_STEREO_VINTERLACE,
RAS_STEREO_MAXSTEREO
2002-10-12 11:37:38 +00:00
};
/**
* Texture gen modes.
*/
enum TexCoGen {
RAS_TEXCO_GEN, //< GPU will generate texture coordinates
RAS_TEXCO_ORCO, //< Vertex coordinates (object space)
RAS_TEXCO_GLOB, //< Vertex coordinates (world space)
RAS_TEXCO_UV1, //< UV coordinates
RAS_TEXCO_OBJECT, //< Use another object's position as coordinates
RAS_TEXCO_LAVECTOR, //< Light vector as coordinates
RAS_TEXCO_VIEW, //< View vector as coordinates
RAS_TEXCO_STICKY, //< Sticky coordinates
RAS_TEXCO_WINDOW, //< Window coordinates
RAS_TEXCO_NORM, //< Normal coordinates
RAS_TEXTANGENT, //<
RAS_TEXCO_UV2, //<
RAS_TEXCO_VCOL, //< Vertex Color
RAS_TEXCO_DISABLE //< Disable this texture unit (cached)
};
/**
* Render pass identifiers for stereo.
*/
enum StereoEye {
2002-10-12 11:37:38 +00:00
RAS_STEREO_LEFTEYE = 1,
RAS_STEREO_RIGHTEYE
2002-10-12 11:37:38 +00:00
};
/**
* SetDepthMask enables or disables writing a fragment's depth value
* to the Z buffer.
*/
virtual void SetDepthMask(DepthMask depthmask)=0;
/**
* SetMaterial sets the material settings for subsequent primitives
* to be rendered with.
* The material will be cached.
*/
virtual bool SetMaterial(const RAS_IPolyMaterial& mat)=0;
/**
* Init initialises the renderer.
*/
2002-10-12 11:37:38 +00:00
virtual bool Init()=0;
/**
* Exit cleans up the renderer.
*/
2002-10-12 11:37:38 +00:00
virtual void Exit()=0;
/**
* BeginFrame is called at the start of each frame.
*/
2002-10-12 11:37:38 +00:00
virtual bool BeginFrame(int drawingmode, double time)=0;
/**
* ClearColorBuffer clears the color buffer.
*/
virtual void ClearColorBuffer()=0;
/**
* ClearDepthBuffer clears the depth buffer.
*/
2002-10-12 11:37:38 +00:00
virtual void ClearDepthBuffer()=0;
/**
* ClearCachingInfo clears the currently cached material.
*/
2002-10-12 11:37:38 +00:00
virtual void ClearCachingInfo(void)=0;
/**
* EndFrame is called at the end of each frame.
*/
2002-10-12 11:37:38 +00:00
virtual void EndFrame()=0;
/**
* SetRenderArea sets the render area from the 2d canvas.
* Returns true if only of subset of the canvas is used.
*/
2002-10-12 11:37:38 +00:00
virtual void SetRenderArea()=0;
// Stereo Functions
/**
* SetStereoMode will set the stereo mode
*/
virtual void SetStereoMode(const StereoMode stereomode)=0;
/**
* Stereo can be used to query if the rasterizer is in stereo mode.
* @return true if stereo mode is enabled.
*/
2002-10-12 11:37:38 +00:00
virtual bool Stereo()=0;
virtual bool InterlacedStereo()=0;
/**
* Sets which eye buffer subsequent primitives will be rendered to.
*/
virtual void SetEye(const StereoEye eye)=0;
virtual StereoEye GetEye()=0;
/**
* Sets the distance between eyes for stereo mode.
*/
2002-10-12 11:37:38 +00:00
virtual void SetEyeSeparation(const float eyeseparation)=0;
virtual float GetEyeSeparation() = 0;
/**
* Sets the focal length for stereo mode.
*/
2002-10-12 11:37:38 +00:00
virtual void SetFocalLength(const float focallength)=0;
virtual float GetFocalLength() = 0;
/**
* SwapBuffers swaps the back buffer with the front buffer.
*/
2002-10-12 11:37:38 +00:00
virtual void SwapBuffers()=0;
// Drawing Functions
/**
* IndexPrimitives: Renders primitives from mesh slot.
*/
virtual void IndexPrimitives(class RAS_MeshSlot& ms)=0;
virtual void IndexPrimitivesMulti(class RAS_MeshSlot& ms)=0;
/**
* IndexPrimitives_3DText will render text into the polygons.
* The text to be rendered is from @param rendertools client object's text property.
*/
virtual void IndexPrimitives_3DText(class RAS_MeshSlot& ms,
2002-10-12 11:37:38 +00:00
class RAS_IPolyMaterial* polymat,
class RAS_IRenderTools* rendertools)=0;
2002-10-12 11:37:38 +00:00
virtual void SetProjectionMatrix(MT_CmMatrix4x4 & mat)=0;
/* This one should become our final version, methinks. */
/**
* Set the projection matrix for the rasterizer. This projects
* from camera coordinates to window coordinates.
* @param mat The projection matrix.
*/
virtual void SetProjectionMatrix(const MT_Matrix4x4 & mat)=0;
/**
* Sets the modelview matrix.
*/
2002-10-12 11:37:38 +00:00
virtual void SetViewMatrix(const MT_Matrix4x4 & mat,
const MT_Vector3& campos,
const MT_Point3 &camLoc,
const MT_Quaternion &camOrientQuat)=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual const MT_Point3& GetCameraPosition()=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual void SetFog(float start,
float dist,
float r,
float g,
float b)=0;
virtual void SetFogColor(float r,
float g,
float b)=0;
virtual void SetFogStart(float start)=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual void SetFogEnd(float end)=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual void DisplayFog()=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual void DisableFog()=0;
virtual void SetBackColor(float red,
float green,
float blue,
float alpha)=0;
/**
* @param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED.
*/
2002-10-12 11:37:38 +00:00
virtual void SetDrawingMode(int drawingmode)=0;
/**
* @return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED.
*/
virtual int GetDrawingMode()=0;
/**
* Sets face culling
*/
2002-10-12 11:37:38 +00:00
virtual void SetCullFace(bool enable)=0;
/**
* Sets wireframe mode.
*/
virtual void SetLines(bool enable)=0;
/**
*/
2002-10-12 11:37:38 +00:00
virtual double GetTime()=0;
/**
* Generates a projection matrix from the specified frustum.
* @param left the left clipping plane
* @param right the right clipping plane
* @param bottom the bottom clipping plane
* @param top the top clipping plane
* @param frustnear the near clipping plane
* @param frustfar the far clipping plane
* @return a 4x4 matrix representing the projection transform.
*/
2002-10-12 11:37:38 +00:00
virtual MT_Matrix4x4 GetFrustumMatrix(
float left,
float right,
float bottom,
float top,
float frustnear,
float frustfar,
float focallength = 0.0f,
bool perspective = true
2002-10-12 11:37:38 +00:00
)=0;
/**
* Sets the specular color component of the lighting equation.
*/
2002-10-12 11:37:38 +00:00
virtual void SetSpecularity(float specX,
float specY,
float specZ,
float specval)=0;
/**
* Sets the specular exponent component of the lighting equation.
*/
2002-10-12 11:37:38 +00:00
virtual void SetShinyness(float shiny)=0;
/**
* Sets the diffuse color component of the lighting equation.
*/
2002-10-12 11:37:38 +00:00
virtual void SetDiffuse(float difX,
float difY,
float difZ,
float diffuse)=0;
/**
* Sets the emissive color component of the lighting equation.
*/
virtual void SetEmissive(float eX,
float eY,
float eZ,
float e
)=0;
virtual void SetAmbientColor(float red, float green, float blue)=0;
virtual void SetAmbient(float factor)=0;
/**
* Sets a polygon offset. z depth will be: z1 = mult*z0 + add
*/
virtual void SetPolygonOffset(float mult, float add) = 0;
2002-10-12 11:37:38 +00:00
virtual void DrawDebugLine(const MT_Vector3& from,const MT_Vector3& to,const MT_Vector3& color)=0;
Merge of apricot branch game engine changes into trunk, excluding GLSL. GLEW ==== Added the GLEW opengl extension library into extern/, always compiled into Blender now. This is much nicer than doing this kind of extension management manually, and will be used in the game engine, for GLSL, and other opengl extensions. * According to the GLEW website it works on Windows, Linux, Mac OS X, FreeBSD, Irix, and Solaris. There might still be platform specific issues due to this commit, so let me know and I'll look into it. * This means also that all extensions will now always be compiled in, regardless of the glext.h on the platform where compilation happens. Game Engine =========== Refactoring of the use of opengl extensions and other drawing code in the game engine, and cleaning up some hacks related to GLSL integration. These changes will be merged into trunk too after this. The game engine graphics demos & apricot level survived my tests, but this could use some good testing of course. For users: please test with the options "Generate Display Lists" and "Vertex Arrays" enabled, these should be the fastest and are supposed to be "unreliable", but if that's the case that's probably due to bugs that can be fixed. * The game engine now also uses GLEW for extensions, replacing the custom opengl extensions code that was there. Removes a lot of #ifdef's, but the runtime checks stay of course. * Removed the WITHOUT_GLEXT environment variable. This was added to work around a specific bug and only disabled multitexturing anyway. It might also have caused a slowdown since it was retrieving the environment variable for every vertex in immediate mode (bug #13680). * Refactored the code to allow drawing skinned meshes with vertex arrays too, removing some specific immediate mode drawing functions for this that only did extra normal calculation. Now it always splits vertices of flat faces instead. * Refactored normal recalculation with some minor optimizations, required for the above change. * Removed some outdated code behind the __NLA_OLDDEFORM #ifdef. * Fixed various bugs in setting of multitexture coordinates and vertex attributes for vertex arrays. These were not being enabled/disabled correct according to the opengl spec, leading to crashes. Also tangent attributes used an immediate mode call for vertex arrays, which can't work. * Fixed use of uninitialized variable in RAS_TexVert. * Exporting skinned meshes was doing O(n^2) lookups for vertices and deform weights, now uses same trick as regular meshes.
2008-06-17 10:27:34 +00:00
virtual void SetTexCoordNum(int num) = 0;
virtual void SetAttribNum(int num) = 0;
virtual void SetTexCoord(TexCoGen coords, int unit) = 0;
virtual void SetAttrib(TexCoGen coords, int unit) = 0;
virtual const MT_Matrix4x4& GetViewMatrix() const = 0;
virtual const MT_Matrix4x4& GetViewInvMatrix() const = 0;
virtual bool QueryLists(){return false;}
virtual bool QueryArrays(){return false;}
virtual void EnableMotionBlur(float motionblurvalue)=0;
virtual void DisableMotionBlur()=0;
virtual float GetMotionBlurValue()=0;
virtual int GetMotionBlurState()=0;
virtual void SetMotionBlurState(int newstate)=0;
virtual void SetBlendingMode(int blendmode)=0;
virtual void SetFrontFace(bool ccw)=0;
2002-10-12 11:37:38 +00:00
};
#endif //__RAS_IRASTERIZER