Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   driver.h Go to the documentation of this file. /* Copyright, 2000 Nevrax Ltd. * * This file is part of NEVRAX NEL. * NEVRAX NEL 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, or (at your option) * any later version. * NEVRAX NEL 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 NEVRAX NEL; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * MA 02111-1307, USA. */ #ifndef NL_DRV_H #define NL_DRV_H #include "nel/misc/types_nl.h" #include "nel/misc/common.h" #include "nel/misc/smart_ptr.h" #include "nel/misc/rgba.h" #include "nel/misc/matrix.h" #include "nel/misc/stream.h" #include "nel/misc/uv.h" #include "3d/texture.h" #include "3d/shader.h" #include "3d/vertex_buffer.h" #include "3d/vertex_buffer_hard.h" #include "3d/vertex_program.h" #include "3d/material.h" #include "nel/misc/mutex.h" #include "nel/3d/primitive_profile.h" #include <vector> #include <list> namespace NLMISC { class IEventEmitter; struct IMouseDevice; struct IKeyboardDevice; struct IInputDeviceManager; class CRect; }; namespace NL3D { using NLMISC::CRefPtr; using NLMISC::CRefCount; using NLMISC::CSmartPtr; using NLMISC::CRGBA; using NLMISC::CVector; using NLMISC::CMatrix; using NLMISC::CSynchronized; class CMaterial; class CPrimitiveBlock; class CLight; class CScissor; class CViewport; struct CMonitorColorProperties; //**************************************************************************** class GfxMode { public: bool OffScreen; bool Windowed; uint16 Width; uint16 Height; uint8 Depth; GfxMode(void) { OffScreen=false; Windowed=false; Width=0; Height=0; Depth=0; } GfxMode(uint16 w, uint16 h, uint8 d, bool windowed= true, bool offscreen=false); }; typedef std::vector<GfxMode> ModeList; //**************************************************************************** // Exceptions. struct EBadDisplay : public NLMISC::Exception { EBadDisplay(const std::string &reason) : Exception(reason) { } }; //**************************************************************************** typedef void (*emptyProc)(void); //**************************************************************************** // *** IMPORTANT ******************** // *** IF YOU MODIFY THE STRUCTURE OF THIS CLASS, PLEASE INCREMENT IDriver::InterfaceVersion TO INVALIDATE OLD DRIVER DLL // ********************************** // // * Driver implementation notes: // * // * Driver implementation must save monitor color parameters at initialization and restaure it at release. class IDriver : public NLMISC::CRefCount { public: static const uint32 InterfaceVersion; public: enum TMessageBoxId { okId=0, yesId, noId, abortId, retryId, cancelId, ignoreId, idCount }; enum TMessageBoxType { okType=0, okCancelType, yesNoType, abortRetryIgnoreType, yesNoCancelType, retryCancelType, typeCount }; enum TMessageBoxIcon { noIcon=0, handIcon, questionIcon, exclamationIcon, asteriskIcon, warningIcon, errorIcon, informationIcon, stopIcon, iconCount }; enum TPolygonMode { Filled=0, Line, Point }; enum TMatrixCount { MaxModelMatrix= 16 }; enum TVBHardType { VBHardAGP=0, VBHardVRAM, CountVBHard }; protected: CSynchronized<TTexDrvInfoPtrMap> _SyncTexDrvInfos; TTexDrvSharePtrList _TexDrvShares; TShaderPtrList _Shaders; TVBDrvInfoPtrList _VBDrvInfos; TPolygonMode _PolygonMode; TVtxPrgDrvInfoPtrList _VtxPrgDrvInfos; public: IDriver(void); virtual ~IDriver(void); virtual bool init(void)=0; virtual ModeList enumModes()=0; // @{ virtual void disableHardwareVertexProgram()=0; virtual void disableHardwareVertexArrayAGP()=0; virtual void disableHardwareTextureShader()=0; // @} // first param is the associated window. // Must be a HWND for Windows (WIN32). virtual bool setDisplay(void* wnd, const GfxMode& mode) throw(EBadDisplay)=0; // Return is the associated window information. (Implementation dependant) // Must be a HWND for Windows (WIN32). virtual void *getDisplay() =0; virtual bool setMonitorColorProperties (const CMonitorColorProperties &properties) = 0; // Return is the associated default window proc for the driver. (Implementation dependant) // Must be a void GlWndProc(IDriver *driver, HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) for Windows (WIN32). virtual emptyProc getWindowProc() =0; virtual bool activate(void)=0; virtual sint getNbTextureStages() const =0; virtual bool isTextureExist(const ITexture&tex)=0; virtual NLMISC::IEventEmitter* getEventEmitter(void)=0; virtual bool clear2D(CRGBA rgba)=0; virtual bool clearZBuffer(float zval=1)=0; virtual void setColorMask (bool bRed, bool bGreen, bool bBlue, bool bAlpha)=0; virtual bool setupTexture(ITexture& tex)=0; virtual bool setupTextureEx (ITexture& tex, bool bUpload, bool& bAllUploaded, bool bMustRecreateSharedTexture= false)=0; virtual bool uploadTexture (ITexture& tex, NLMISC::CRect& rect, uint8 nNumMipMap)=0; virtual bool uploadTextureCube (ITexture& tex, NLMISC::CRect& rect, uint8 nNumMipMap, uint8 nNumFace)=0; bool invalidateShareTexture (ITexture &); static void getTextureShareName (const ITexture& tex, std::string &output); virtual void forceDXTCCompression(bool dxtcComp)=0; virtual void forceTextureResize(uint divisor)=0; virtual bool setupMaterial(CMaterial& mat)=0; // Setup the camera mode as a perspective/ortho camera. NB: znear and zfar must be >0 (if perspective). virtual void setFrustum(float left, float right, float bottom, float top, float znear, float zfar, bool perspective=true)=0; virtual void setupViewMatrix(const CMatrix& mtx)=0; virtual void setupViewMatrixEx(const CMatrix& mtx, const CVector &cameraPos)=0; virtual void setupModelMatrix(const CMatrix& mtx)=0; virtual void multiplyModelMatrix(const CMatrix& mtx)=0; virtual CMatrix getViewMatrix(void)const=0; virtual void forceNormalize(bool normalize)=0; virtual bool isForceNormalize() const =0; virtual bool supportVertexBufferHard() const =0; virtual bool slowUnlockVertexBufferHard() const =0; virtual uint getMaxVerticesByVertexBufferHard() const =0; virtual bool initVertexArrayRange(uint agpMem, uint vramMem=0) =0; virtual IVertexBufferHard *createVertexBufferHard(uint16 vertexFormat, const uint8 *typeArray, uint32 numVertices, TVBHardType vbType) =0; virtual void deleteVertexBufferHard(IVertexBufferHard *VB) =0; virtual void activeVertexBufferHard(IVertexBufferHard *VB)=0; virtual bool activeVertexBuffer(CVertexBuffer& VB)=0; virtual bool activeVertexBuffer(CVertexBuffer& VB, uint first, uint end)=0; virtual void mapTextureStageToUV(uint stage, uint uv)=0; virtual bool render(CPrimitiveBlock& PB, CMaterial& Mat)=0; virtual void renderTriangles(CMaterial& Mat, uint32 *tri, uint32 ntris)=0; virtual void renderSimpleTriangles(uint32 *tri, uint32 ntris)=0; virtual void renderPoints(CMaterial& Mat, uint32 numPoints)=0; virtual void renderQuads(CMaterial& Mat, uint32 startIndex, uint32 numQuads)=0; virtual bool swapBuffers(void)=0; // @{ virtual void profileRenderedPrimitives(CPrimitiveProfile &pIn, CPrimitiveProfile &pOut) =0; virtual uint32 profileAllocatedTextureMemory() =0; virtual uint32 profileSetupedMaterials() const =0; virtual uint32 profileSetupedModelMatrix() const =0; virtual void enableUsedTextureMemorySum (bool enable=true) =0; virtual uint32 getUsedTextureMemory() const =0; // @} // @{ virtual bool fogEnabled()=0; virtual void enableFog(bool enable)=0; virtual void setupFog(float start, float end, CRGBA color)=0; // @} virtual bool release(void); virtual bool isActive()=0; virtual uint8 getBitPerPixel ()=0; virtual TMessageBoxId systemMessageBox (const char* message, const char* title, TMessageBoxType type=okType, TMessageBoxIcon icon=noIcon); virtual void setupViewport (const class CViewport& viewport)=0; virtual void setupScissor (const class CScissor& scissor)=0; virtual uint32 getImplementationVersion () const = 0; virtual const char* getDriverInformation () = 0; virtual const char* getVideocardInformation () = 0; // @{ virtual void showCursor (bool b) = 0; virtual void setMousePos (float x, float y) = 0; virtual NLMISC::IMouseDevice *enableLowLevelMouse(bool enable) = 0; virtual NLMISC::IKeyboardDevice *enableLowLevelKeyboard(bool enable) = 0; virtual void setCapture (bool b) = 0; virtual NLMISC::IInputDeviceManager *getLowLevelInputDeviceManager() = 0; // @} virtual void getWindowSize (uint32 &width, uint32 &height) = 0; virtual void getBuffer (CBitmap &bitmap) = 0; virtual void getZBuffer (std::vector<float> &zbuffer) = 0; virtual void getBufferPart (CBitmap &bitmap, NLMISC::CRect &rect) = 0; virtual void getZBufferPart (std::vector<float> &zbuffer, NLMISC::CRect &rect) = 0; virtual void copyFrameBufferToTexture(ITexture *tex, uint32 level, uint32 offsetx, uint32 offsety, uint32 x, uint32 y, uint32 width, uint32 height ) = 0 ; virtual bool fillBuffer (CBitmap &bitmap) = 0; virtual void setPolygonMode (TPolygonMode mode) { _PolygonMode=mode; } virtual uint getMaxLight () const = 0; virtual void setLight (uint8 num, const CLight& light) = 0; virtual void enableLight (uint8 num, bool enable=true) = 0; virtual void setAmbientColor (CRGBA color) = 0; virtual void setPerPixelLightingLight(CRGBA diffuse, CRGBA specular, float shininess) = 0; TPolygonMode getPolygonMode () { return _PolygonMode; } // @{ enum TMatrix { ModelView= 0, Projection, ModelViewProjection, NumMatrix }; enum TTransform { Identity=0, Inverse, Transpose, InverseTranspose, NumTransform }; virtual bool isVertexProgramSupported () const =0; virtual bool isVertexProgramEmulated () const =0; virtual bool activeVertexProgram (CVertexProgram *program) =0; virtual void setConstant (uint index, float, float, float, float) =0; virtual void setConstant (uint index, double, double, double, double) =0; virtual void setConstant (uint index, const NLMISC::CVector& value) =0; virtual void setConstant (uint index, const NLMISC::CVectorD& value) =0; virtual void setConstant (uint index, uint num, const float *src) =0; virtual void setConstant (uint index, uint num, const double *src) =0; virtual void setConstantMatrix (uint index, TMatrix matrix, TTransform transform) =0; virtual bool supportVertexProgramDoubleSidedColor() const = 0; virtual void enableVertexProgramDoubleSidedColor(bool doubleSided) =0; // @} // @{ virtual bool supportTextureShaders() const = 0; virtual bool isTextureAddrModeSupported(CMaterial::TTexAddressingMode mode) const = 0; virtual void setMatrix2DForTextureOffsetAddrMode(const uint stage, const float mat[4]) = 0; // @{ // Test if EMBM is supported. virtual bool supportEMBM() const = 0; // Test if EMBM is supported for the given stage virtual bool isEMBMSupportedAtStage(uint stage) const = 0; // set the matrix used for EMBM adressing : virtual void setEMBMMatrix(const uint stage, const float mat[4]) = 0; // @} // Does the driver support the per-pixel lighting shader ? virtual bool supportPerPixelLighting(bool specular) const = 0; // @{ virtual bool supportBlendConstantColor() const =0; virtual void setBlendConstantColor(NLMISC::CRGBA col)=0; virtual NLMISC::CRGBA getBlendConstantColor() const =0; // @} virtual void swapTextureHandle(ITexture &tex0, ITexture &tex1) =0; protected: friend class IVBDrvInfos; friend class CTextureDrvShare; friend class ITextureDrvInfos; friend class IShader; friend class IVertexProgramDrvInfos; void removeVBDrvInfoPtr(ItVBDrvInfoPtrList vbDrvInfoIt); void removeTextureDrvInfoPtr(ItTexDrvInfoPtrMap texDrvInfoIt); void removeTextureDrvSharePtr(ItTexDrvSharePtrList texDrvShareIt); void removeShaderPtr(ItShaderPtrList shaderIt); void removeVtxPrgDrvInfoPtr(ItVtxPrgDrvInfoPtrList vtxPrgDrvInfoIt); }; // -------------------------------------------------- } #endif // NL_DRV_H