ScummVM API documentation
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LowLevelGraphicsSDL.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * Copyright (C) 2006-2010 - Frictional Games
24  *
25  * This file is part of HPL1 Engine.
26  */
27 
28 #ifndef HPL_LOWLEVELGRAPHICS_SDL_H
29 #define HPL_LOWLEVELGRAPHICS_SDL_H
30 
31 #include "common/ptr.h"
32 #include "graphics/pixelformat.h"
33 #include "graphics/surface.h"
34 #include "hpl1/engine/graphics/LowLevelGraphics.h"
35 #include "hpl1/engine/math/MathTypes.h"
36 #include "hpl1/opengl.h"
37 
38 #ifdef USE_OPENGL
39 
40 namespace hpl {
41 
42 //-------------------------------------------------
43 
44 GLenum ColorFormatToGL(eColorDataFormat format);
45 
46 GLenum TextureTargetToGL(eTextureTarget target);
47 
48 //-------------------------------------------------
49 
50 class cLowLevelGraphicsSDL : public iLowLevelGraphics {
51 public:
52  cLowLevelGraphicsSDL();
53  ~cLowLevelGraphicsSDL();
54 
55  bool Init(int alWidth, int alHeight, int alBpp, int abFullscreen, int alMultisampling,
56  const tString &asWindowCaption);
57 
58  int GetCaps(eGraphicCaps aType) const;
59 
60  void ShowCursor(bool abX);
61 
62  void SetMultisamplingActive(bool abX);
63 
64  void SetGammaCorrection(float afX);
65  float GetGammaCorrection();
66 
67  int GetMultisampling() { return mlMultisampling; }
68 
69  void SetClipPlane(int alIdx, const cPlanef &aPlane);
70  cPlanef GetClipPlane(int alIdx, const cPlanef &aPlane);
71  void SetClipPlaneActive(int alIdx, bool abX);
72 
73  cVector2f GetScreenSize();
74  cVector2f GetVirtualSize();
75  void SetVirtualSize(cVector2f avSize);
76 
77  Bitmap2D *CreateBitmap2D(const cVector2l &avSize);
78  FontData *CreateFontData(const tString &asName);
79 
80  iTexture *CreateTexture(bool abUseMipMaps, eTextureType aType, eTextureTarget aTarget);
81  iTexture *CreateTexture(const tString &asName, bool abUseMipMaps, eTextureType aType, eTextureTarget aTarget);
82  iTexture *CreateTexture(Bitmap2D *apBmp, bool abUseMipMaps, eTextureType aType, eTextureTarget aTarget);
83  iTexture *CreateTexture(const cVector2l &avSize, int alBpp, cColor aFillCol,
84  bool abUseMipMaps, eTextureType aType, eTextureTarget aTarget);
85 
86  Graphics::PixelFormat *GetPixelFormat();
87 
88  iGpuProgram *CreateGpuProgram(const tString &vertex, const tString &fragment);
89 
90  void SaveScreenToBMP(const tString &asFile);
91 
93 
94  void PushMatrix(eMatrix aMtxType);
95  void PopMatrix(eMatrix aMtxType);
96  void SetIdentityMatrix(eMatrix aMtxType);
97 
98  void SetMatrix(eMatrix aMtxType, const cMatrixf &a_mtxA);
99 
100  void TranslateMatrix(eMatrix aMtxType, const cVector3f &avPos);
101  void RotateMatrix(eMatrix aMtxType, const cVector3f &avRot);
102  void ScaleMatrix(eMatrix aMtxType, const cVector3f &avScale);
103 
104  void SetOrthoProjection(const cVector2f &avSize, float afMin, float afMax);
105 
107 
108  // OCCLUSION
109  iOcclusionQuery *CreateOcclusionQuery();
110  void DestroyOcclusionQuery(iOcclusionQuery *apQuery);
111 
112  // CLEARING THE FRAMEBUFFER
113  void ClearScreen();
114 
115  void SetClearColor(const cColor &aCol);
116  void SetClearDepth(float afDepth);
117  void SetClearStencil(int alVal);
118 
119  void SetClearColorActive(bool abX);
120  void SetClearDepthActive(bool abX);
121  void SetClearStencilActive(bool abX);
122 
123  void SetColorWriteActive(bool abR, bool abG, bool abB, bool abA);
124  void SetDepthWriteActive(bool abX);
125 
126  void SetCullActive(bool abX);
127  void SetCullMode(eCullMode aMode);
128 
129  // DEPTH
130  void SetDepthTestActive(bool abX);
131  void SetDepthTestFunc(eDepthTestFunc aFunc);
132 
133  // ALPHA
134  void SetAlphaTestActive(bool abX);
135  void SetAlphaTestFunc(eAlphaTestFunc aFunc, float afRef);
136 
137  // STENCIL
138  void SetStencilActive(bool abX);
139  /*void SetStencilTwoSideActive(bool abX);
140  void SetStencilFace(eStencilFace aFace);
141  void SetStencilFunc(eStencilFunc aFunc,int alRef, unsigned int aMask);
142  void SetStencilOp(eStencilOp aFailOp,eStencilOp aZFailOp,eStencilOp aZPassOp);*/
143  void SetStencil(eStencilFunc aFunc, int alRef, unsigned int aMask,
144  eStencilOp aFailOp, eStencilOp aZFailOp, eStencilOp aZPassOp);
145  void SetStencilTwoSide(eStencilFunc aFrontFunc, eStencilFunc aBackFunc,
146  int alRef, unsigned int aMask,
147  eStencilOp aFrontFailOp, eStencilOp aFrontZFailOp, eStencilOp aFrontZPassOp,
148  eStencilOp aBackFailOp, eStencilOp aBackZFailOp, eStencilOp aBackZPassOp);
149  void SetStencilTwoSide(bool abX);
150 
151  // SCISSOR
152  void SetScissorActive(bool abX);
153  void SetScissorRect(const cRect2l &aRect);
154 
155  // BLENDING
156  void SetBlendActive(bool abX);
157  void SetBlendFunc(eBlendFunc aSrcFactor, eBlendFunc aDestFactor);
158  void SetBlendFuncSeparate(eBlendFunc aSrcFactorColor, eBlendFunc aDestFactorColor,
159  eBlendFunc aSrcFactorAlpha, eBlendFunc aDestFactorAlpha);
160 
161  // TEXTURE
162  void SetTexture(unsigned int alUnit, iTexture *apTex);
163  void SetActiveTextureUnit(unsigned int alUnit);
164  void SetTextureEnv(eTextureParam aParam, int alVal);
165  void SetTextureConstantColor(const cColor &color);
166 
167  void SetColor(const cColor &aColor);
168 
169  // POLYGONS
170  iVertexBuffer *CreateVertexBuffer(tVertexFlag aFlags, eVertexBufferDrawType aDrawType,
171  eVertexBufferUsageType aUsageType,
172  int alReserveVtxSize = 0, int alReserveIdxSize = 0);
173 
174  void DrawRect(const cVector2f &avPos, const cVector2f &avSize, float afZ);
175 
176  void DrawTri(const tVertexVec &avVtx);
177  void DrawTri(const cVertex *avVtx);
178 
179  void DrawQuad(const tVertexVec &avVtx);
180  void DrawQuad(const tVertexVec &avVtx, const cColor aCol);
181  void DrawQuad(const tVertexVec &avVtx, const float afZ);
182  void DrawQuad(const tVertexVec &avVtx, const float afZ, const cColor &aCol);
183  void DrawQuadMultiTex(const tVertexVec &avVtx, const tVector3fVec &avExtraUvs);
184 
185  void AddVertexToBatch(const cVertex &apVtx);
186  void AddVertexToBatch(const cVertex *apVtx, const cVector3f *avTransform);
187  void AddVertexToBatch(const cVertex *apVtx, const cMatrixf *aMtx);
188 
189  void AddVertexToBatch_Size2D(const cVertex *apVtx, const cVector3f *avTransform,
190  const cColor *apCol, const float &mfW, const float &mfH);
191 
192  void AddVertexToBatch_Raw(const cVector3f &avPos, const cColor &aColor,
193  const cVector3f &avTex);
194 
195  void AddTexCoordToBatch(unsigned int alUnit, const cVector3f *apCoord);
196  void SetBatchTextureUnitActive(unsigned int alUnit, bool abActive);
197 
198  void AddIndexToBatch(int alIndex);
199 
200  void FlushTriBatch(tVtxBatchFlag aTypeFlags, bool abAutoClear = true);
201  void FlushQuadBatch(tVtxBatchFlag aTypeFlags, bool abAutoClear = true);
202  void ClearBatch();
203 
204  // PRIMITIVES
205  void DrawLine(const cVector3f &avBegin, const cVector3f &avEnd, cColor aCol);
206  void DrawBoxMaxMin(const cVector3f &avMax, const cVector3f &avMin, cColor aCol);
207  void DrawSphere(const cVector3f &avPos, float afRadius, cColor aCol);
208 
209  void DrawLine2D(const cVector2f &avBegin, const cVector2f &avEnd, float afZ, cColor aCol);
210  void DrawLineRect2D(const cRect2f &aRect, float afZ, cColor aCol);
211  void DrawLineCircle2D(const cVector2f &avCenter, float afRadius, float afZ, cColor aCol);
212 
213  void DrawFilledRect2D(const cRect2f &aRect, float afZ, cColor aCol);
214 
215  // FRAMEBUFFER
216  void CopyContextToTexure(iTexture *apTex, const cVector2l &avPos,
217  const cVector2l &avSize, const cVector2l &avTexOffset = 0);
218  void SetRenderTarget(iTexture *pTex);
219  bool RenderTargetHasZBuffer();
220  void FlushRenderTarget();
221 
222  void FlushRendering();
223  void SwapBuffers();
224 
226 
227  void SetupGL();
228 
229  GLenum GetGLTextureTargetEnum(eTextureTarget aType);
230 
231 private:
232  cVector2l mvScreenSize;
233  cVector2f mvVirtualSize;
234  int mlMultisampling;
235  int mlBpp;
236 
237  // Gamma
238  // uint16 mvStartGammaArray[3][256];
239  float mfGammaCorrection;
240 
241  // Clipping
242  cPlanef mvClipPlanes[kMaxClipPlanes];
243 
244  // SDL Variables
245  // SDL_Surface *mpScreen;
246  Graphics::PixelFormat mpPixelFormat;
247 
248  // Vertex Array variables
249  // The vertex arrays used:
250  float *mpVertexArray;
251  unsigned int mlVertexCount;
252  unsigned int *mpIndexArray;
253  unsigned int mlIndexCount;
254 
255  unsigned int mlBatchStride;
256 
257  float *mpTexCoordArray[MAX_TEXTUREUNITS];
258  bool mbTexCoordArrayActive[MAX_TEXTUREUNITS];
259  unsigned int mlTexCoordArrayCount[MAX_TEXTUREUNITS];
260 
261  unsigned int mlBatchArraySize;
262 
263  // Clearing
264  bool mbClearColor;
265  bool mbClearDepth;
266  bool mbClearStencil;
267 
268  // Rendertarget variables
269  iTexture *mpRenderTarget;
270 
271  // Texture
272  iTexture *mpCurrentTexture[MAX_TEXTUREUNITS];
273 
274  iTexture *_screenBuffer;
275  iGpuProgram *_gammaCorrectionProgram;
276 
277  // CG Compiler Variables
278  // CGcontext mCG_Context;
279 
280  // Multisample
281  void CheckMultisampleCaps();
282 
283  void applyGammaCorrection();
284 
285  // Batch helper
286  void SetUpBatchArrays();
287 
288  // Depth helper
289  GLenum GetGLDepthTestFuncEnum(eDepthTestFunc aType);
290 
291  // Alpha Helper
292  GLenum GetGLAlphaTestFuncEnum(eAlphaTestFunc aType);
293 
294  // Stencil helper
295  GLenum GetGLStencilFuncEnum(eStencilFunc aType);
296  GLenum GetGLStencilOpEnum(eStencilOp aType);
297 
298  // Matrix Helper
299  void SetMatrixMode(eMatrix mType);
300 
301  // Texture helper
302  GLenum GetGLTextureParamEnum(eTextureParam aType);
303  GLenum GetGLTextureOpEnum(eTextureOp aType);
304  GLenum GetGLTextureFuncEnum(eTextureFunc aType);
305  GLenum GetGLTextureSourceEnum(eTextureSource aType);
306 
307  // Blend helper
308  GLenum GetGLBlendEnum(eBlendFunc aType);
309 
310  // Vtx helper
311  void SetVtxBatchStates(tVtxBatchFlag flags);
312 };
313 
314 } // namespace hpl
315 
316 #endif // USE_OPENGL
317 #endif // HPL_LOWLEVELGRAPHICS_SDL_H
hpl
Definition: AI.h:36
Graphics::PixelFormat
Definition: pixelformat.h:138