{-# LANGUAGE MultiParamTypeClasses, FunctionalDependencies #-}
module Graphics.LambdaCube.RenderSystem where
import Data.Word
import Data.Maybe
import qualified Data.Set as Set
import Foreign.C.Types
import Control.Monad
import Graphics.LambdaCube.Types
import Graphics.LambdaCube.Common
import Graphics.LambdaCube.BlendMode
import Graphics.LambdaCube.Texture
import Graphics.LambdaCube.GpuProgram
import Graphics.LambdaCube.TextureUnitState
import Graphics.LambdaCube.Image
import Graphics.LambdaCube.Light
import Graphics.LambdaCube.RenderSystemCapabilities
import Graphics.LambdaCube.RenderOperation
import Graphics.LambdaCube.HardwareBuffer
import Graphics.LambdaCube.HardwareVertexBuffer
import Graphics.LambdaCube.HardwareIndexBuffer
import Graphics.LambdaCube.HardwareOcclusionQuery
import Graphics.LambdaCube.PixelFormat
import Graphics.LambdaCube.Pass
-- | Enum describing the ways to generate texture coordinates
data TexCoordCalcMethod
= TEXCALC_NONE -- ^ No calculated texture coordinates
| TEXCALC_ENVIRONMENT_MAP -- ^ Environment map based on vertex normals
| TEXCALC_ENVIRONMENT_MAP_PLANAR -- ^ Environment map based on vertex positions
| TEXCALC_ENVIRONMENT_MAP_REFLECTION -- ^ Environment map based on vertex positions
| TEXCALC_ENVIRONMENT_MAP_NORMAL -- ^ Environment map based on vertex positions
| TEXCALC_PROJECTIVE_TEXTURE -- ^ Projective texture
deriving Eq
-- | Enum describing the various actions which can be taken onthe stencil buffer
data StencilOperation
= SOP_KEEP -- ^ Leave the stencil buffer unchanged
| SOP_ZERO -- ^ Set the stencil value to zero
| SOP_REPLACE -- ^ Set the stencil value to the reference value
| SOP_INCREMENT -- ^ Increase the stencil value by 1, clamping at the maximum value
| SOP_DECREMENT -- ^ Decrease the stencil value by 1, clamping at 0
| SOP_INCREMENT_WRAP -- ^ Increase the stencil value by 1, wrapping back to 0 when incrementing the maximum value
| SOP_DECREMENT_WRAP -- ^ Decrease the stencil value by 1, wrapping when decrementing 0
| SOP_INVERT -- ^ Invert the bits of the stencil buffer
deriving Eq
{-| Defines the functionality of a 3D API
@remarks
The RenderSystem class provides a base interface
which abstracts the general functionality of the 3D API
e.g. Direct3D or OpenGL. Whilst a few of the general
methods have implementations, most of this class is
abstract, requiring a subclass based on a specific API
to be constructed to provide the full functionality.
Note there are 2 levels to the interface - one which
will be used often by the caller of the Ogre library,
and one which is at a lower level and will be used by the
other classes provided by Ogre. These lower level
methods are prefixed with '_' to differentiate them.
The advanced user of the library may use these lower
level methods to access the 3D API at a more fundamental
level (dealing direct with render states and rendering
primitives), but still benefiting from Ogre's abstraction
of exactly which 3D API is in use.
@author
Steven Streeting
@version
1.0
-}
class (HardwareVertexBuffer vb, HardwareIndexBuffer ib, HardwareOcclusionQuery q, Texture t, GpuProgram p, LinkedGpuProgram lp) => RenderSystem a vb ib q t p lp | a -> vb ib q t p lp where
{-| Create a hardware vertex buffer.
@remarks
This method creates a new vertex buffer; this will act as a source of geometry
data for rendering objects. Note that because the meaning of the contents of
the vertex buffer depends on the usage, this method does not specify a
vertex format; the user of this buffer can actually insert whatever data
they wish, in any format. However, in order to use this with a RenderOperation,
the data in this vertex buffer will have to be associated with a semantic element
of the rendering pipeline, e.g. a position, or texture coordinates. This is done
using the VertexDeclaration class, which itself contains VertexElement structures
referring to the source data.
@remarks Note that because vertex buffers can be shared, they are reference
counted so you do not need to worry about destroying themm this will be done
automatically.
@param vertexSize The size in bytes of each vertex in this buffer; you must calculate
this based on the kind of data you expect to populate this buffer with.
@param numVerts The number of vertices in this buffer.
@param usage One or more members of the HardwareBuffer::Usage enumeration; you are
strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to
update regularly, consider HBU_DYNAMIC_WRITE_ONLY and useShadowBuffer=true.
@param useShadowBuffer If set to true, this buffer will be 'shadowed' by one stored in
system memory rather than GPU or AGP memory. You should set this flag if you intend
to read data back from the vertex buffer, because reading data from a buffer
in the GPU or AGP memory is very expensive, and is in fact impossible if you
specify HBU_WRITE_ONLY for the main buffer. If you use this option, all
reads and writes will be done to the shadow buffer, and the shadow buffer will
be synchronised with the real buffer at an appropriate time.
-}
createVertexBuffer :: a -> Int -> Int -> Usage -> Bool -> IO vb
{-| Create a hardware index buffer.
@remarks Note that because buffers can be shared, they are reference
counted so you do not need to worry about destroying them this will be done
automatically.
@param itype The type in index, either 16- or 32-bit, depending on how many vertices
you need to be able to address
@param numIndexes The number of indexes in the buffer
@param usage One or more members of the HardwareBuffer::Usage enumeration.
@param useShadowBuffer If set to true, this buffer will be 'shadowed' by one stored in
system memory rather than GPU or AGP memory. You should set this flag if you intend
to read data back from the index buffer, because reading data from a buffer
in the GPU or AGP memory is very expensive, and is in fact impossible if you
specify HBU_WRITE_ONLY for the main buffer. If you use this option, all
reads and writes will be done to the shadow buffer, and the shadow buffer will
be synchronised with the real buffer at an appropriate time.
-}
createIndexBuffer :: a -> IndexType -> Int -> Usage -> Bool -> IO ib
{-
virtual TexturePtr createManual(const String & name, const String& group,
TextureType texType, uint width, uint height, uint depth,
int num_mips, PixelFormat format, int usage = TU_DEFAULT, ManualResourceLoader* loader = 0,
bool hwGammaCorrection = false, uint fsaa = 0, const String& fsaaHint = StringUtil::BLANK);
TextureUsage = bufferUsage::Usage, autoMipmap::Bool, isTarget::Bool
-}
createTexture :: a -> String -> TextureType -> Int -> Int -> Int -> TextureMipmap -> PixelFormat -> TextureUsage -> Bool -> Int -> String -> Maybe [Image] -> IO t
--FIXME: TEMP HACK!!!!!
dirtyHackCopyTexImage :: a -> t -> Int -> Int -> Int -> Int -> IO ()
createGpuProgram :: a -> GpuProgramType -> String -> IO (Either p String) -- TODO
createLinkedGpuProgram :: a -> [p] -> IO (Either lp String) -- TODO
getName :: a -> String -- ^ Returns the name of the rendering system.
createOcclusionQuery :: a -> IO q -- ^ Create an object for performing hardware occlusion queries.
-- destroyOcclusionQuery :: a -> q -> IO () -- ^ Destroy a hardware occlusion query object.
--obsolete createRenderSystemCapabilities :: a -> IO RenderSystemCapabilities -- ^ Query the real capabilities of the GPU and driver in the RenderSystem
-- reinitialise :: a -> IO () -- ^ Restart the renderer (normally following a change in settings).
-- shutdown :: a -> IO () -- ^ Shutdown the renderer and cleanup resources.
setAmbientLight :: a -> Float -> Float -> Float -> IO () -- ^ Sets the colour & strength of the ambient (global directionless) light in the world.
setShadingType :: a -> ShadeOptions -> IO () -- ^ Sets the type of light shading required (default = Gouraud).
{-| Sets whether or not dynamic lighting is enabled.
@param
enabled If true, dynamic lighting is performed on geometry with normals supplied, geometry without
normals will not be displayed. If false, no lighting is applied and all geometry will be full brightness.
-}
setLightingEnabled :: a -> Bool -> IO ()
{-| Sets whether or not W-buffers are enabled if they are available for this renderer.
@param
enabled If true and the renderer supports them W-buffers will be used. If false
W-buffers will not be used even if available. W-buffers are enabled by default
for 16bit depth buffers and disabled for all other depths.
-}
setWBufferEnabled :: a -> Bool -> IO ()
-- getWBufferEnabled :: a -> IO Bool -- ^ Returns true if the renderer will try to use W-buffers when avalible.
{-| Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures
at once. Surfaces can be bound and unbound at will.
This fails if mCapabilities->getNumMultiRenderTargets() is smaller than 2.
-}
-- TODO: virtual MultiRenderTarget * createMultiRenderTarget(const String & name) = 0;
{-| Destroys a render texture -}
-- TODO: virtual void destroyRenderTexture(const String& name);
{-| Destroys a render target of any sort -}
-- TODO: virtual void destroyRenderTarget(const String& name);
{-| Attaches the passed render target to the render system.
-}
-- TODO: virtual void attachRenderTarget( RenderTarget &target );
{-| Returns a pointer to the render target with the passed name, or NULL if that
render target cannot be found.
-}
-- TODO: virtual RenderTarget * getRenderTarget( const String &name );
{-| Detaches the render target with the passed name from the render system and
returns a pointer to it.
@note
If the render target cannot be found, NULL is returned.
-}
-- TODO: virtual RenderTarget * detachRenderTarget( const String &name );
-- | Iterator over RenderTargets
-- TODO: typedef MapIterator
final = (texture * sourceFactor) + (pixel * destFactor)
Each of the factors is specified as one of a number of options, as specified in the SceneBlendFactor enumerated type. By changing the operation you can change addition between the source and destination pixels to a different operator. @param sourceFactor The source factor in the above calculation, i.e. multiplied by the texture colour components. @param destFactor The destination factor in the above calculation, i.e. multiplied by the pixel colour components. @param op The blend operation mode for combining pixels -} setSceneBlending :: a -> SceneBlendFactor -> SceneBlendFactor -> SceneBlendOperation -> IO () {-| Sets the global blending factors for combining subsequent renders with the existing frame contents. The result of the blending operation is:final = (texture * sourceFactor) + (pixel * destFactor)
Each of the factors is specified as one of a number of options, as specified in the SceneBlendFactor enumerated type. @param sourceFactor The source factor in the above calculation, i.e. multiplied by the texture colour components. @param destFactor The destination factor in the above calculation, i.e. multiplied by the pixel colour components. @param sourceFactorAlpha The source factor in the above calculation for the alpha channel, i.e. multiplied by the texture alpha components. @param destFactorAlpha The destination factor in the above calculation for the alpha channel, i.e. multiplied by the pixel alpha components. @param op The blend operation mode for combining pixels @param alphaOp The blend operation mode for combining pixel alpha values -} setSeparateSceneBlending :: a -> SceneBlendFactor -> SceneBlendFactor -> SceneBlendFactor -> SceneBlendFactor -> SceneBlendOperation -> SceneBlendOperation -> IO () {-| Sets the global alpha rejection approach for future renders. By default images are rendered regardless of texture alpha. This method lets you change that. @param func The comparison function which must pass for a pixel to be written. @param val The value to compare each pixels alpha value to (0-255) @param alphaToCoverage Whether to enable alpha to coverage, if supported -} setAlphaRejectSettings :: a -> CompareFunction -> Int -> Bool -> IO () {-| Notify the rendersystem that it should adjust texture projection to be relative to a different origin. -} -- TODO: virtual void _setTextureProjectionRelativeTo(bool enabled, const Vector3& pos); {-| * Signifies the beginning of a frame, i.e. the start of rendering on a single viewport. Will occur * several times per complete frame if multiple viewports exist. -} -- TODO: virtual void _beginFrame(void) = 0; {-| * Ends rendering of a frame to the current viewport. -} -- TODO: virtual void _endFrame(void) = 0; {-| Sets the provided viewport as the active one for future rendering operations. This viewport is aware of it's own camera and render target. Must be implemented by subclass. @param target Pointer to the appropriate viewport. -} setViewport :: a -> Int -> Int -> Int -> Int -> IO () {-| Get the current active viewport for rendering. -} -- TODO: virtual Viewport* _getViewport(void); {-| Sets the culling mode for the render system based on the 'vertex winding'. A typical way for the rendering engine to cull triangles is based on the 'vertex winding' of triangles. Vertex winding refers to the direction in which the vertices are passed or indexed to in the rendering operation as viewed from the camera, and will wither be clockwise or anticlockwise (that's 'counterclockwise' for you Americans out there ;) The default is CULL_CLOCKWISE i.e. that only triangles whose vertices are passed/indexed in anticlockwise order are rendered - this is a common approach and is used in 3D studio models for example. You can alter this culling mode if you wish but it is not advised unless you know what you are doing. You may wish to use the CULL_NONE option for mesh data that you cull yourself where the vertex winding is uncertain. -} setCullingMode :: a -> CullingMode -> IO () -- getCullingMode :: a -> IO CullingMode {-| Sets the mode of operation for depth buffer tests from this point onwards. Sometimes you may wish to alter the behaviour of the depth buffer to achieve special effects. Because it's unlikely that you'll set these options for an entire frame, but rather use them to tweak settings between rendering objects, this is an internal method (indicated by the '_' prefix) which will be used by a SceneManager implementation rather than directly from the client application. If this method is never called the settings are automatically the same as the default parameters. @param depthTest If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. @param depthWrite If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. @param depthFunction Sets the function required for the depth test. -} setDepthBufferParams :: a -> Bool -> Bool -> CompareFunction -> IO () {-| Sets whether or not the depth buffer check is performed before a pixel write. @param enabled If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. -} setDepthBufferCheckEnabled :: a -> Bool -> IO () {-| Sets whether or not the depth buffer is updated after a pixel write. @param enabled If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. -} setDepthBufferWriteEnabled :: a -> Bool -> IO () {-| Sets the comparison function for the depth buffer check. Advanced use only - allows you to choose the function applied to compare the depth values of new and existing pixels in the depth buffer. Only an issue if the deoth buffer check is enabled (see _setDepthBufferCheckEnabled) @param func The comparison between the new depth and the existing depth which must return true for the new pixel to be written. -} --setDepthBufferFunction :: a -> CompareFunction -> IO () setDepthBufferFunction :: a -> Bool -> CompareFunction -> IO () {-| Sets whether or not colour buffer writing is enabled, and for which channels. @remarks For some advanced effects, you may wish to turn off the writing of certain colour channels, or even all of the colour channels so that only the depth buffer is updated in a rendering pass. However, the chances are that you really want to use this option through the Material class. @param red, green, blue, alpha Whether writing is enabled for each of the 4 colour channels. -} setColourBufferWriteEnabled :: a -> Bool -> Bool -> Bool -> Bool -> IO () {-| Sets the depth bias, NB you should use the Material version of this. @remarks When polygons are coplanar, you can get problems with 'depth fighting' where the pixels from the two polys compete for the same screen pixel. This is particularly a problem for decals (polys attached to another surface to represent details such as bulletholes etc.). @par A way to combat this problem is to use a depth bias to adjust the depth buffer value used for the decal such that it is slightly higher than the true value, ensuring that the decal appears on top. @note The final bias value is a combination of a constant bias and a bias proportional to the maximum depth slope of the polygon being rendered. The final bias is constantBias + slopeScaleBias * maxslope. Slope scale biasing is generally preferable but is not available on older hardware. @param constantBias The constant bias value, expressed as a value in homogeneous depth coordinates. @param slopeScaleBias The bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards. -} setDepthBias :: a -> FloatType -> FloatType -> IO () {-| Sets the fogging mode for future geometry. @param mode Set up the mode of fog as described in the FogMode enum, or set to FOG_NONE to turn off. @param colour The colour of the fog. Either set this to the same as your viewport background colour, or to blend in with a skydome or skybox. @param expDensity The density of the fog in FOG_EXP or FOG_EXP2 mode, as a value between 0 and 1. The default is 1. i.e. completely opaque, lower values can mean that fog never completely obscures the scene. @param linearStart Distance at which linear fog starts to encroach. The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR. @param linearEnd Distance at which linear fog becomes completely opaque.The distance must be passed as a parametric value between 0 and 1, with 0 being the near clipping plane, and 1 being the far clipping plane. Only applicable if mode is FOG_LINEAR. -} setFog :: a -> FogMode -> ColourValue -> FloatType -> FloatType -> FloatType -> IO () {-| The RenderSystem will keep a count of tris rendered, this resets the count. -} -- TODO: virtual void _beginGeometryCount(void); {-| Reports the number of tris rendered since the last _beginGeometryCount call. -} -- TODO: virtual unsigned int _getFaceCount(void) const; {-| Reports the number of batches rendered since the last _beginGeometryCount call. -} -- TODO: virtual unsigned int _getBatchCount(void) const; {-| Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. -} -- TODO: virtual unsigned int _getVertexCount(void) const; {-| Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem. @remarks Since different render systems have different colour data formats (eg RGBA for GL, ARGB for D3D) this method allows you to use 1 method for all. @param colour The colour to convert @param pDest Pointer to location to put the result. -} -- TODO: virtual void convertColourValue(const ColourValue& colour, uint32* pDest); {-| Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. -} -- TODO: virtual VertexElementType getColourVertexElementType(void) const = 0; {-| Converts a uniform projection matrix to suitable for this render system. @remarks Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine. -} -- TODO: virtual void _convertProjectionMatrix(const Matrix4& matrix, -- TODO: Matrix4& dest, bool forGpuProgram = false) = 0; {-| Builds a perspective projection matrix suitable for this render system. @remarks Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine. -} -- TODO: virtual void _makeProjectionMatrix(const Radian& fovy, Real aspect, Real nearPlane, Real farPlane, -- TODO: Matrix4& dest, bool forGpuProgram = false) = 0; {-| Builds a perspective projection matrix for the case when frustum is not centered around camera. @remarks Viewport coordinates are in camera coordinate frame, i.e. camera is at the origin. -} -- TODO: virtual void _makeProjectionMatrix(Real left, Real right, Real bottom, Real top, -- TODO: Real nearPlane, Real farPlane, Matrix4& dest, bool forGpuProgram = false) = 0; {-| Builds an orthographic projection matrix suitable for this render system. @remarks Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine. -} -- TODO: virtual void _makeOrthoMatrix(const Radian& fovy, Real aspect, Real nearPlane, Real farPlane, -- TODO: Matrix4& dest, bool forGpuProgram = false) = 0; {-| Update a perspective projection matrix to use 'oblique depth projection'. @remarks This method can be used to change the nature of a perspective transform in order to make the near plane not perpendicular to the camera view direction, but to be at some different orientation. This can be useful for performing arbitrary clipping (e.g. to a reflection plane) which could otherwise only be done using user clip planes, which are more expensive, and not necessarily supported on all cards. @param matrix The existing projection matrix. Note that this must be a perspective transform (not orthographic), and must not have already been altered by this method. The matrix will be altered in-place. @param plane The plane which is to be used as the clipping plane. This plane must be in CAMERA (view) space. @param forGpuProgram Is this for use with a Gpu program or fixed-function -} -- TODO: virtual void _applyObliqueDepthProjection(Matrix4& matrix, const Plane& plane, -- TODO: bool forGpuProgram) = 0; {-| Sets how to rasterise triangles, as points, wireframe or solid polys. -} setPolygonMode :: a -> PolygonMode -> IO () {-| Turns stencil buffer checking on or off. @remarks Stencilling (masking off areas of the rendering target based on the stencil buffer) can be turned on or off using this method. By default, stencilling is disabled. -} setStencilCheckEnabled :: a -> Bool -> IO () {-| Determines if this system supports hardware accelerated stencil buffer. @remarks Note that the lack of this function doesn't mean you can't do stencilling, but the stencilling operations will be provided in software, which will NOT be fast. @par Generally hardware stencils are only supported in 32-bit colour modes, because the stencil buffer shares the memory of the z-buffer, and in most cards the z-buffer has to be the same depth as the colour buffer. This means that in 32-bit mode, 24 bits of the z-buffer are depth and 8 bits are stencil. In 16-bit mode there is no room for a stencil (although some cards support a 15:1 depth:stencil option, this isn't useful for very much) so 8 bits of stencil are provided in software. This can mean that if you use stencilling, your applications may be faster in 32-but colour than in 16-bit, which may seem odd to some people. -} {-virtual bool hasHardwareStencil(void) = 0;-} {-| This method allows you to set all the stencil buffer parameters in one call. @remarks The stencil buffer is used to mask out pixels in the render target, allowing you to do effects like mirrors, cut-outs, stencil shadows and more. Each of your batches of rendering is likely to ignore the stencil buffer, update it with new values, or apply it to mask the output of the render. The stencil test is:(Reference Value & Mask) CompareFunction (Stencil Buffer Value & Mask)The result of this will cause one of 3 actions depending on whether the test fails, succeeds but with the depth buffer check still failing, or succeeds with the depth buffer check passing too. @par Unlike other render states, stencilling is left for the application to turn on and off when it requires. This is because you are likely to want to change parameters between batches of arbitrary objects and control the ordering yourself. In order to batch things this way, you'll want to use OGRE's separate render queue groups (see RenderQueue) and register a RenderQueueListener to get notifications between batches. @par There are individual state change methods for each of the parameters set using this method. Note that the default values in this method represent the defaults at system start up too. @param func The comparison function applied. @param refValue The reference value used in the comparison @param mask The bitmask applied to both the stencil value and the reference value before comparison @param stencilFailOp The action to perform when the stencil check fails @param depthFailOp The action to perform when the stencil check passes, but the depth buffer check still fails @param passOp The action to take when both the stencil and depth check pass. @param twoSidedOperation If set to true, then if you render both back and front faces (you'll have to turn off culling) then these parameters will apply for front faces, and the inverse of them will happen for back faces (keep remains the same). -} setStencilBufferParams :: a -> CompareFunction -> Word32 -> Word32 -> StencilOperation -> StencilOperation -> StencilOperation -> Bool -> IO () {-| Sets the current vertex declaration, ie the source of vertex data. -} -- setVertexDeclaration :: a -> VertexDeclaration -> IO () {-| Sets the current vertex buffer binding state. -} -- setVertexBufferBinding :: a -> VertexBufferBinding vb -> IO () {-| Sets whether or not normals are to be automatically normalised. @remarks This is useful when, for example, you are scaling SceneNodes such that normals may not be unit-length anymore. Note though that this has an overhead so should not be turn on unless you really need it. @par You should not normally call this direct unless you are rendering world geometry; set it on the Renderable because otherwise it will be overridden by material settings. -} setNormaliseNormals :: a -> Bool -> IO () {-| Render something to the active viewport. Low-level rendering interface to perform rendering operations. Unlikely to be used directly by client applications, since the SceneManager and various support classes will be responsible for calling this method. Can only be called between _beginScene and _endScene @param Iteration count @param op A rendering operation instance, which contains details of the operation to be performed. -} render :: a -> RenderOperation vb ib -> IO () bindGeometry :: a -> RenderOperation vb ib -> [TextureUnitState t] -> IO () unbindGeometry :: a -> RenderOperation vb ib -> IO () {-| Gets the capabilities of the render system. -} getCapabilities :: a -> RenderSystemCapabilities {-| Binds a given GpuProgram (but not the parameters). @remarks Only one GpuProgram of each type can be bound at once, binding another one will simply replace the existing one. -} bindLinkedGpuProgram :: a -> lp -> IO () -- bindGpuProgram :: a -> GpuProgram -> IO () {-| Bind Gpu program parameters. @param gptype The type of program to bind the parameters to @param params The parameters to bind @param variabilityMask A mask of GpuParamVariability identifying which params need binding -} -- bindGpuProgramParameters :: a -> GpuProgramType -> GpuProgramParameters -> Word16 -> IO () {-| Only binds Gpu program parameters used for passes that have more than one iteration rendering -} -- bindGpuProgramPassIterationParameters :: a -> GpuProgramType -> IO () {-| Unbinds GpuPrograms of a given GpuProgramType. @remarks This returns the pipeline to fixed-function processing for this type. -} unbindLinkedGpuProgram :: a -> IO () -- unbindGpuProgram :: a -> GpuProgramType -> IO () {-| Returns whether or not a Gpu program of the given type is currently bound. -} -- isGpuProgramBound :: a -> GpuProgramType -> IO Bool {-| Sets the user clipping region. -} -- TODO: virtual void setClipPlanes(const PlaneList& clipPlanes); {-| Add a user clipping plane. -} -- TODO: virtual void addClipPlane (const Plane &p); {-| Add a user clipping plane. -} -- TODO: virtual void addClipPlane (Real A, Real B, Real C, Real D); {-| Clears the user clipping region. -} -- TODO: virtual void resetClipPlanes(); {-| Utility method for initialising all render targets attached to this rendering system. -} -- TODO: virtual void _initRenderTargets(void); {-| Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. -} -- TODO: virtual void _notifyCameraRemoved(const Camera* cam); {-| Internal method for updating all render targets attached to this rendering system. -} -- TODO: virtual void _updateAllRenderTargets(bool swapBuffers = true); {-| Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. -} -- TODO: virtual void _swapAllRenderTargetBuffers(bool waitForVsync = true); {-| Gets whether or not vertex windings set should be inverted; this can be important for rendering reflections. -} -- TODO: virtual bool getInvertVertexWinding(void); {-| Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. -} -- TODO: virtual void setInvertVertexWinding(bool invert); {-| Sets the 'scissor region' ie the region of the target in which rendering can take place. @remarks This method allows you to 'mask off' rendering in all but a given rectangular area as identified by the parameters to this method. @note Not all systems support this method. Check the RenderSystemCapabilities for the RSC_SCISSOR_TEST capability to see if it is supported. @param enabled True to enable the scissor test, false to disable it. @param left, top, right, bottom The location of the corners of the rectangle, expressed in pixels. -} setScissorTest :: a -> Bool -> Int -> Int -> Int -> Int -> IO () {-| Clears one or more frame buffers on the active render target. @param buffers Combination of one or more elements of FrameBufferType denoting which buffers are to be cleared @param colour The colour to clear the colour buffer with, if enabled @param depth The value to initialise the depth buffer with, if enabled @param stencil The value to initialise the stencil buffer with, if enabled. -} clearFrameBuffer :: a -> FrameBufferType -> ColourValue -> FloatType -> Word16 -> IO () {-| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. @remarks Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the horizontal direction. -} getHorizontalTexelOffset :: a -> IO FloatType {-| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. @remarks Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the vertical direction. -} getVerticalTexelOffset :: a -> IO FloatType {-| Gets the minimum (closest) depth value to be used when rendering using identity transforms. @remarks When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value. @see Renderable::getUseIdentityView, Renderable::getUseIdentityProjection -} getMinimumDepthInputValue :: a -> FloatType {-| Gets the maximum (farthest) depth value to be used when rendering using identity transforms. @remarks When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value. @see Renderable::getUseIdentityView, Renderable::getUseIdentityProjection -} getMaximumDepthInputValue :: a -> FloatType {-| set the current multi pass count value. This must be set prior to calling _render() if multiple renderings of the same pass state are required. @param count Number of times to render the current state. -} -- TODO: virtual void setCurrentPassIterationCount(const size_t count) { mCurrentPassIterationCount = count; } {-| Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. The depth bias set will be baseValue + iteration * multiplier @param derive True to tell the RS to derive this automatically @param baseValue The base value to which the multiplier should be added @param multiplier The amount of depth bias to apply per iteration @param slopeScale The constant slope scale bias for completeness -} -- TODO: virtual void setDeriveDepthBias(bool derive, float baseValue = 0.0f, -- TODO: float multiplier = 0.0f, float slopeScale = 0.0f) -- TODO: { -- TODO: mDerivedDepthBias = derive; -- TODO: mDerivedDepthBiasBase = baseValue; -- TODO: mDerivedDepthBiasMultiplier = multiplier; -- TODO: mDerivedDepthBiasSlopeScale = slopeScale; -- TODO: } {-| * Set current render target to target, enabling its device context if needed -} -- TODO: virtual void _setRenderTarget(RenderTarget *target) = 0; class (HardwareVertexBuffer vb, HardwareIndexBuffer ib, Texture t, LinkedGpuProgram lp) => Renderable r vb ib t lp | r -> vb ib t lp where prepare :: Matrix4 -> r -> [RenderEntity vb ib t lp] data (HardwareVertexBuffer vb, HardwareIndexBuffer ib, Texture t, LinkedGpuProgram lp) => RenderEntity vb ib t lp = RenderEntity { reOperation :: RenderOperation vb ib , rePassList :: [Pass t lp] , reMatrix :: Matrix4 } --setPass :: RenderSystem -> Pass -> IO () setPass time rs pass = do let rsc = getCapabilities rs caps = rscCapabilities rsc Pass { --psName :: String -- ^ optional name for the pass -- Colour properties, only applicable in fixed-function passes psAmbient = ambient , psDiffuse = diffuse , psSpecular = specular , psEmissive = emissive , psShininess = shininess , psTracking = vertexColourTracking -- Blending factors , psSourceBlendFactor = sourceBlendFactor , psDestBlendFactor = destBlendFactor , psSourceBlendFactorAlpha = sourceBlendFactorAlpha , psDestBlendFactorAlpha = destBlendFactorAlpha , psSeparateBlend = separateBlend -- Blending operations , psBlendOperation = blendOperation , psAlphaBlendOperation = alphaBlendOperation , psSeparateBlendOperation = separateBlendOperation -- Depth buffer settings , psDepthCheck = depthCheck , psDepthWrite = depthWrite , psDepthFunc = depthFunc , psDepthBiasConstant = depthBiasConstant , psDepthBiasSlopeScale = depthBiasSlopeScale -- , psDepthBiasPerIteration :: FloatType -- Colour buffer settings , psColourWrite = colourWrite -- Alpha reject settings , psAlphaRejectFunc = alphaRejectFunc , psAlphaRejectVal = alphaRejectVal , psAlphaToCoverageEnabled = alphaToCoverageEnabled -- , psTransparentSorting :: Bool -- ^ Transparent depth sorting -- , psTransparentSortingForced :: Bool -- ^ Transparent depth sorting forced -- Culling mode , psCullMode = cullMode -- , psManualCullMode :: ManualCullingMode , psLightingEnabled = lightingEnabled -- , psMaxSimultaneousLights :: Int -- ^ Max simultaneous lights -- , psStartLight :: Int -- ^ Starting light index -- , psLightsPerIteration :: Maybe Int -- ^ Run this pass once per light? Iterate per how many lights? -- , psOnlyLightType :: Maybe LightTypes -- ^ Should it only be run for a certain light type? , psShadeOptions = shadeOptions , psPolygonMode = polygonMode -- Normalisation -- , psNormaliseNormals :: Bool , psPolygonModeOverrideable = polygonModeOverrideable -- Fog , psFogOverride = fogOverride , psFogMode = fogMode , psFogColour = fogColour , psFogStart = fogStart , psFogEnd = fogEnd , psFogDensity = fogDensity , psTextureUnitStates = textureUnitStates , psVertexProgramUsage = vertexProgramUsage -- , psShadowCasterVertexProgramUsage :: GpuProgramUsage -- ^ Vertex program details -- , psShadowReceiverVertexProgramUsage :: GpuProgramUsage -- ^ Vertex program details , psFragmentProgramUsage = fragmentProgramUsage -- , psShadowReceiverFragmentProgramUsage :: GpuProgramUsage -- ^ Fragment program details , psGeometryProgramUsage = geometryProgramUsage , psLinkedGpuProgram = linkedGpuProgram -- , psQueuedForDeletion :: Bool -- ^ Is this pass queued for deletion? -- , psPassIterationCount :: Int -- ^ number of pass iterations to perform , psPointSize = pointSize , psPointMinSize = pointMinSize , psPointMaxSize = pointMaxSize , psPointSpritesEnabled = pointSpritesEnabled , psPointAttenuationEnabled = pointAttenuationEnabled -- , psPointAttenuationCoeffs :: FloatType3 -- ^ constant, linear, quadratic coeffs {- // TU Content type lookups typedef vector