blender/source/gameengine/Rasterizer/RAS_IRasterizer.h

489 lines
13 KiB
C
Raw Normal View History

/*
* ***** 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,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* 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
*/
/** \file RAS_IRasterizer.h
* \ingroup bgerast
*/
#ifndef __RAS_IRASTERIZER_H__
#define __RAS_IRASTERIZER_H__
2002-10-12 11:37:38 +00:00
#ifdef _MSC_VER
# pragma warning (disable:4786)
2002-10-12 11:37:38 +00:00
#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;
#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif
2002-10-12 11:37:38 +00:00
class RAS_ICanvas;
class RAS_IPolyMaterial;
class RAS_MeshSlot;
typedef vector<unsigned short> KX_IndexArray;
typedef vector<RAS_TexVert> KX_VertexArray;
2013-12-23 18:44:54 +00:00
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:
enum RAS_TEXT_RENDER_MODE {
RAS_TEXT_RENDER_NODEF = 0,
RAS_TEXT_NORMAL,
RAS_TEXT_PADDED,
2013-12-23 18:44:54 +00:00
RAS_TEXT_MAX,
};
2012-07-21 22:58:08 +00:00
RAS_IRasterizer(RAS_ICanvas* canv) {};
virtual ~RAS_IRasterizer() {};
TexFace to Material Settings big patch Summary: ======== The idea here is to move the texface options into the material panel. For images with the change please visit: http://code.blender.org/index.php/2011/09/bge-material-texface-changes 1 - Some of the legacy problems 2.49 and 2.5x has with the texface system: ========================================================================== 1.1) Shadow, Bilboard and Halo are mutual exclusive (in the code), yet you can select a face to be more than one mode. 1.2) Sort only works for blend Alpha yet it's an option regardless of the Transparency Blend you pick. 1.3) Shared doesn't affect anything in BGE. 1.4) ObColor only works for Text objects (old bitmap texts) when using Texture Face Materials. (not address yet, I so far ignored obcolor) 2 - Notes: ============ 2.1) Now "Use Face Textures" in material Option panel will work in Multitexture even if there is no texture channel. 2.2) In FaceTexture mode it will use TexFace all the time, even if you don't check the "Use Texture Face" option in the UI. It's a matter of decision, since the code for either way is there. I decided by the solution that makes the creation of a material fast - in this mode the user doesn't need to mess with textures or this "Use Texture Face" option at all. I'm not strong in my opinion here. But I think if we don't have this then what is the point of the Texture Face mode? 2.3) I kept references for tface only when we need the image, UV or the tiling setting. It should help later when/if we split the Image and UV layers from the tface struct (Campbell and Brecht proposal). 3 - Changes in a Nutshell: ========================== 3.1) "Texture Face" panel (in the Mesh/Object Data panel) no longer exists. Those settings are all part of the material properties, visible when Game Render is set. 3.2) "Texture Face" Shading mode (in the Render panel) is now called “Single Texture”, it needs a material for special settings (e.g. Billboard, Alpha Sort, …). 3.3) New options in the Material Panel * Shadeless option in the Material panel is now supported for all three Shading modes. * Physics is now toggleable, this is the old Collision option. * Two Side (on) is now called Back Culling (off). * Alpha Sort is one of the Alpha options, together (and mutually exclusive) to Alpha Blend, Alpha Clip, Add and Opaque (i.e. solid). * Shadow, Billboard and Halo are grouped in the “Face Orientation” property. * "Face Textures" and "Face Textures Alpha" (under Options) can be used for all but GLSL shading mode (to be supported in GLSL eventually). * The backend in the game engine is still the same as before. The only changes are in the interface and in the way you need to think your materials. The bottomline is: It’s no longer possible to share materials between faces that do not share the same game properties. 4 - Acknowledgment: ================== Mike Pan for the design discussions, and testing along the whole development process. Vitor Balbio for the first hands-on code with the interface changes. That helped me a lot to push me into work on that. Benoit Bolsee and Brecht van Lommel for patch review (* no one reviewed the whole patch, or the latest iteractions, so I still hold liability for any problems). Blender artists that gave feedback and helped testing the patch. Patch review and original documentation can be found here: http://wiki.blender.org/index.php/User:Dfelinto/TexFace http://codereview.appspot.com/4289041/
2011-09-19 19:55:59 +00:00
/**
* Drawing types
*/
enum DrawType {
2013-12-23 18:44:54 +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,
2013-12-23 18:44:54 +00:00
KX_MODE_QUADS,
2002-10-12 11:37:38 +00:00
};
/**
* Valid SetDepthMask parameters
*/
enum DepthMask {
2013-12-23 18:44:54 +00:00
KX_DEPTHMASK_ENABLED = 1,
KX_DEPTHMASK_DISABLED,
2002-10-12 11:37:38 +00:00
};
/**
*/
enum {
2013-12-23 18:44:54 +00:00
RAS_RENDER_3DPOLYGON_TEXT = 64, /* GEMAT_TEXT */
KX_BACKCULL = 16, /* GEMAT_BACKCULL */
KX_TEX = 4096, /* GEMAT_TEX */
KX_LINES = 32768,
};
/**
* Stereo mode types
*/
enum StereoMode {
2013-12-23 18:44:54 +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_DOME,
RAS_STEREO_3DTVTOPBOTTOM,
2013-12-23 18:44:54 +00:00
RAS_STEREO_MAXSTEREO
2002-10-12 11:37:38 +00:00
};
/**
* Texture gen modes.
*/
enum TexCoGen {
2013-12-23 18:44:54 +00:00
RAS_TEXCO_GEN, /* < GPU will generate texture coordinates */
RAS_TEXCO_ORCO, /* < Vertex coordinates (object space) */
RAS_TEXCO_GLOB, /* < Vertex coordinates (world space) */
RAS_TEXCO_UV, /* < 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_VCOL, /* < Vertex Color */
RAS_TEXCO_DISABLE, /* < Disable this texture unit (cached) */
};
/**
* Render pass identifiers for stereo.
*/
enum StereoEye {
2013-12-23 18:44:54 +00:00
RAS_STEREO_LEFTEYE = 1,
RAS_STEREO_RIGHTEYE,
2002-10-12 11:37:38 +00:00
};
/**
* Mipmap options
*/
enum MipmapOption {
RAS_MIPMAP_NONE,
RAS_MIPMAP_NEAREST,
RAS_MIPMAP_LINEAR,
2013-12-23 18:44:54 +00:00
RAS_MIPMAP_MAX, /* Should always be last */
};
/**
* SetDepthMask enables or disables writing a fragment's depth value
* to the Z buffer.
*/
2013-12-23 18:44:54 +00:00
virtual void SetDepthMask(DepthMask depthmask) = 0;
/**
* SetMaterial sets the material settings for subsequent primitives
* to be rendered with.
* The material will be cached.
*/
2013-12-23 18:44:54 +00:00
virtual bool SetMaterial(const RAS_IPolyMaterial &mat) = 0;
/**
* Init initializes the renderer.
*/
2013-12-23 18:44:54 +00:00
virtual bool Init() = 0;
/**
* Exit cleans up the renderer.
*/
2013-12-23 18:44:54 +00:00
virtual void Exit() = 0;
/**
* BeginFrame is called at the start of each frame.
*/
2013-12-23 18:44:54 +00:00
virtual bool BeginFrame(int drawingmode, double time) = 0;
/**
* ClearColorBuffer clears the color buffer.
*/
2013-12-23 18:44:54 +00:00
virtual void ClearColorBuffer() = 0;
/**
* ClearDepthBuffer clears the depth buffer.
*/
2013-12-23 18:44:54 +00:00
virtual void ClearDepthBuffer() = 0;
/**
* ClearCachingInfo clears the currently cached material.
*/
2013-12-23 18:44:54 +00:00
virtual void ClearCachingInfo(void) = 0;
/**
* EndFrame is called at the end of each frame.
*/
2013-12-23 18:44:54 +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.
*/
2013-12-23 18:44:54 +00:00
virtual void SetRenderArea() = 0;
2002-10-12 11:37:38 +00:00
// Stereo Functions
/**
* SetStereoMode will set the stereo mode
*/
2013-12-23 18:44:54 +00:00
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.
*/
2013-12-23 18:44:54 +00:00
virtual bool Stereo() = 0;
virtual StereoMode GetStereoMode() = 0;
virtual bool InterlacedStereo() = 0;
/**
* Sets which eye buffer subsequent primitives will be rendered to.
*/
2013-12-23 18:44:54 +00:00
virtual void SetEye(const StereoEye eye) = 0;
virtual StereoEye GetEye() = 0;
/**
* Sets the distance between eyes for stereo mode.
*/
2013-12-23 18:44:54 +00:00
virtual void SetEyeSeparation(const float eyeseparation) = 0;
virtual float GetEyeSeparation() = 0;
/**
* Sets the focal length for stereo mode.
*/
2013-12-23 18:44:54 +00:00
virtual void SetFocalLength(const float focallength) = 0;
virtual float GetFocalLength() = 0;
/**
* SwapBuffers swaps the back buffer with the front buffer.
*/
2013-12-23 18:44:54 +00:00
virtual void SwapBuffers() = 0;
// Drawing Functions
/**
* IndexPrimitives: Renders primitives from mesh slot.
*/
2013-12-23 18:44:54 +00:00
virtual void IndexPrimitives(class RAS_MeshSlot &ms) = 0;
virtual void IndexPrimitivesMulti(class RAS_MeshSlot &ms) = 0;
/**
* IndexPrimitives_3DText will render text into the polygons.
*/
2013-12-23 18:44:54 +00:00
virtual void IndexPrimitives_3DText(class RAS_MeshSlot &ms, class RAS_IPolyMaterial *polymat) = 0;
virtual void SetProjectionMatrix(MT_CmMatrix4x4 &mat) = 0;
2002-10-12 11:37:38 +00:00
/* 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.
2002-10-12 11:37:38 +00:00
*/
2013-12-23 18:44:54 +00:00
virtual void SetProjectionMatrix(const MT_Matrix4x4 &mat) = 0;
/**
* Sets the modelview matrix.
*/
2013-12-23 18:44:54 +00:00
virtual void SetViewMatrix(const MT_Matrix4x4 &mat, const MT_Matrix3x3 &ori,
const MT_Point3 &pos, bool perspective) = 0;
/**
*/
2013-12-23 18:44:54 +00:00
virtual const MT_Point3& GetCameraPosition() = 0;
virtual bool GetCameraOrtho() = 0;
2002-10-12 11:37:38 +00:00
/**
2013-12-23 18:44:54 +00:00
* Fog
*/
2013-12-23 18:44:54 +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;
virtual void SetFogEnd(float end) = 0;
virtual void DisplayFog() = 0;
virtual void DisableFog() = 0;
virtual bool IsFogEnabled() = 0;
2002-10-12 11:37:38 +00:00
2013-12-23 18:44:54 +00:00
virtual void SetBackColor(float red, float green, float blue, float alpha) = 0;
2002-10-12 11:37:38 +00:00
/**
* \param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED.
*/
2013-12-23 18:44:54 +00:00
virtual void SetDrawingMode(int drawingmode) = 0;
/**
* \return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED.
*/
2013-12-23 18:44:54 +00:00
virtual int GetDrawingMode() = 0;
/**
* Sets face culling
2012-09-16 04:58:18 +00:00
*/
2013-12-23 18:44:54 +00:00
virtual void SetCullFace(bool enable) = 0;
/**
* Sets wireframe mode.
*/
2013-12-23 18:44:54 +00:00
virtual void SetLines(bool enable) = 0;
/**
*/
2013-12-23 18:44:54 +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(
2013-12-23 18:44:54 +00:00
float left, float right, float bottom, float top,
float frustnear, float frustfar,
float focallength = 0.0f, bool perspective = true) = 0;
/**
* Generates a orthographic 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.
*/
virtual MT_Matrix4x4 GetOrthoMatrix(
2013-12-23 18:44:54 +00:00
float left, float right, float bottom, float top,
float frustnear, float frustfar) = 0;
/**
* Sets the specular color component of the lighting equation.
*/
2013-12-23 18:44:54 +00:00
virtual void SetSpecularity(float specX, float specY, float specZ, float specval) = 0;
/**
* Sets the specular exponent component of the lighting equation.
*/
2013-12-23 18:44:54 +00:00
virtual void SetShinyness(float shiny) = 0;
/**
* Sets the diffuse color component of the lighting equation.
*/
2013-12-23 18:44:54 +00:00
virtual void SetDiffuse(float difX,float difY, float difZ, float diffuse) = 0;
/**
* Sets the emissive color component of the lighting equation.
*/
2013-12-23 18:44:54 +00:00
virtual void SetEmissive(float eX, float eY, float eZ, float e) = 0;
2013-12-23 18:44:54 +00:00
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
2013-12-23 18:44:54 +00:00
virtual void DrawDebugLine(const MT_Vector3 &from, const MT_Vector3 &to, const MT_Vector3& color) = 0;
virtual void DrawDebugCircle(const MT_Vector3 &center, const MT_Scalar radius, const MT_Vector3 &color,
const MT_Vector3 &normal, int nsector) = 0;
virtual void FlushDebugShapes() = 0;
2013-12-23 18:44:54 +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, int layer = 0) = 0;
2013-12-23 18:44:54 +00:00
virtual const MT_Matrix4x4 &GetViewMatrix() const = 0;
virtual const MT_Matrix4x4 &GetViewInvMatrix() const = 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
2013-12-23 18:44:54 +00:00
virtual bool QueryLists() { return false; }
virtual bool QueryArrays() { return false; }
2013-12-23 18:44:54 +00:00
virtual void EnableMotionBlur(float motionblurvalue) = 0;
virtual void DisableMotionBlur() = 0;
2013-12-23 18:44:54 +00:00
virtual float GetMotionBlurValue() = 0;
virtual int GetMotionBlurState() = 0;
virtual void SetMotionBlurState(int newstate) = 0;
2013-12-23 18:44:54 +00:00
virtual void SetAlphaBlend(int alphablend) = 0;
virtual void SetFrontFace(bool ccw) = 0;
2013-12-23 18:44:54 +00:00
virtual void SetAnisotropicFiltering(short level) = 0;
virtual short GetAnisotropicFiltering() = 0;
2013-12-23 18:44:54 +00:00
virtual void SetMipmapping(MipmapOption val) = 0;
virtual MipmapOption GetMipmapping() = 0;
2013-12-23 18:44:54 +00:00
virtual void SetUsingOverrideShader(bool val) = 0;
virtual bool GetUsingOverrideShader() = 0;
/**
* Render Tools
*/
2013-12-23 18:44:54 +00:00
virtual void applyTransform(double *oglmatrix, int drawingmode) = 0;
/**
* Renders 2D boxes.
* \param xco Position on the screen (origin in lower left corner).
* \param yco Position on the screen (origin in lower left corner).
* \param width Width of the canvas to draw to.
* \param height Height of the canvas to draw to.
* \param percentage Percentage of bar.
*/
2013-12-23 18:44:54 +00:00
virtual void RenderBox2D(int xco, int yco, int width, int height, float percentage) = 0;
/**
* Renders 3D text string using BFL.
* \param fontid The id of the font.
* \param text The string to render.
* \param size The size of the text.
* \param dpi The resolution of the text.
* \param color The color of the object.
* \param mat The Matrix of the text object.
* \param aspect A scaling factor to compensate for the size.
*/
2013-12-23 18:44:54 +00:00
virtual void RenderText3D(
int fontid, const char *text, int size, int dpi,
const float color[4], const double mat[16], float aspect) = 0;
/**
* Renders 2D text string.
* \param mode The type of text
* \param text The string to render.
* \param xco Position on the screen (origin in lower left corner).
* \param yco Position on the screen (origin in lower left corner).
* \param width Width of the canvas to draw to.
* \param height Height of the canvas to draw to.
*/
2013-12-23 18:44:54 +00:00
virtual void RenderText2D(
RAS_TEXT_RENDER_MODE mode, const char *text,
int xco, int yco, int width, int height) = 0;
2013-12-23 18:44:54 +00:00
virtual void ProcessLighting(bool uselights, const MT_Transform &trans) = 0;
2013-12-23 18:44:54 +00:00
virtual void PushMatrix() = 0;
2013-12-23 18:44:54 +00:00
virtual void PopMatrix() = 0;
2013-12-23 18:44:54 +00:00
virtual void AddLight(struct RAS_LightObject *lightobject) = 0;
2013-12-23 18:44:54 +00:00
virtual void RemoveLight(struct RAS_LightObject *lightobject) = 0;
2013-12-23 18:44:54 +00:00
virtual void MotionBlur() = 0;
2013-12-23 18:44:54 +00:00
virtual void SetClientObject(void *obj) = 0;
2013-12-23 18:44:54 +00:00
virtual void SetAuxilaryClientInfo(void *inf) = 0;
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("GE:RAS_IRasterizer")
#endif
2002-10-12 11:37:38 +00:00
};
#endif /* __RAS_IRASTERIZER_H__ */