Safe Haskell | None |
---|
- delete :: HG3DClass -> IO ()
- getName :: HG3DClass -> IO String
- getMetrics :: HG3DClass -> IO (Int, Int, Int)
- getWidth :: HG3DClass -> IO Int
- getHeight :: HG3DClass -> IO Int
- getColourDepth :: HG3DClass -> IO Int
- setDepthBufferPool :: HG3DClass -> Int -> IO ()
- getDepthBufferPool :: HG3DClass -> IO Int
- detachDepthBuffer :: HG3DClass -> IO ()
- update :: HG3DClass -> Bool -> IO ()
- swapBuffers :: HG3DClass -> Bool -> IO ()
- addViewport :: HG3DClass -> HG3DClass -> Int -> Float -> Float -> Float -> Float -> IO HG3DClass
- getNumViewports :: HG3DClass -> IO Int
- getViewport :: HG3DClass -> Int -> IO HG3DClass
- getViewportByZOrder :: HG3DClass -> Int -> IO HG3DClass
- hasViewportWithZOrder :: HG3DClass -> Int -> IO Bool
- removeViewport :: HG3DClass -> Int -> IO ()
- removeAllViewports :: HG3DClass -> IO ()
- getStatistics :: HG3DClass -> IO (Float, Float, Float, Float)
- getLastFPS :: HG3DClass -> IO Float
- getAverageFPS :: HG3DClass -> IO Float
- getBestFPS :: HG3DClass -> IO Float
- getWorstFPS :: HG3DClass -> IO Float
- getBestFrameTime :: HG3DClass -> IO Float
- getWorstFrameTime :: HG3DClass -> IO Float
- resetStatistics :: HG3DClass -> IO ()
- removeAllListeners :: HG3DClass -> IO ()
- isActive :: HG3DClass -> IO Bool
- setActive :: HG3DClass -> Bool -> IO ()
- setAutoUpdated :: HG3DClass -> Bool -> IO ()
- isAutoUpdated :: HG3DClass -> IO Bool
- writeContentsToFile :: HG3DClass -> String -> IO ()
- writeContentsToTimestampedFile :: HG3DClass -> String -> String -> IO String
- requiresTextureFlipping :: HG3DClass -> IO Bool
- getTriangleCount :: HG3DClass -> IO Int
- getBatchCount :: HG3DClass -> IO Int
- isPrimary :: HG3DClass -> IO Bool
- isHardwareGammaEnabled :: HG3DClass -> IO Bool
- getFSAA :: HG3DClass -> IO Int
- getFSAAHint :: HG3DClass -> IO String
- delete'_ :: HG3DClassPtr -> IO ()
- getName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- getMetrics'_ :: HG3DClassPtr -> Ptr CUInt -> Ptr CUInt -> Ptr CUInt -> IO ()
- getWidth'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()
- getHeight'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()
- getColourDepth'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()
- setDepthBufferPool'_ :: HG3DClassPtr -> CUShort -> IO ()
- getDepthBufferPool'_ :: HG3DClassPtr -> Ptr CUShort -> IO ()
- detachDepthBuffer'_ :: HG3DClassPtr -> IO ()
- update'_ :: HG3DClassPtr -> CInt -> IO ()
- swapBuffers'_ :: HG3DClassPtr -> CInt -> IO ()
- addViewport'_ :: HG3DClassPtr -> HG3DClassPtr -> CInt -> CFloat -> CFloat -> CFloat -> CFloat -> HG3DClassPtr -> IO ()
- getNumViewports'_ :: HG3DClassPtr -> Ptr CUShort -> IO ()
- getViewport'_ :: HG3DClassPtr -> CUShort -> HG3DClassPtr -> IO ()
- getViewportByZOrder'_ :: HG3DClassPtr -> CInt -> HG3DClassPtr -> IO ()
- hasViewportWithZOrder'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()
- removeViewport'_ :: HG3DClassPtr -> CInt -> IO ()
- removeAllViewports'_ :: HG3DClassPtr -> IO ()
- getStatistics'_ :: HG3DClassPtr -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> IO ()
- getLastFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getAverageFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getBestFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getWorstFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getBestFrameTime'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getWorstFrameTime'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- resetStatistics'_ :: HG3DClassPtr -> IO ()
- removeAllListeners'_ :: HG3DClassPtr -> IO ()
- isActive'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- setActive'_ :: HG3DClassPtr -> CInt -> IO ()
- setAutoUpdated'_ :: HG3DClassPtr -> CInt -> IO ()
- isAutoUpdated'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- writeContentsToFile'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- writeContentsToTimestampedFile'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CChar -> Ptr CChar -> IO ()
- requiresTextureFlipping'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getTriangleCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getBatchCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isPrimary'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isHardwareGammaEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getFSAA'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()
- getFSAAHint'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
Documentation
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO String |
Retrieve target's name.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO (Int, Int, Int) | width |
Retrieve information about the render target.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Int | poolId |
-> IO () |
Sets the pool ID this RenderTargetDepthBuffer Changing the pool Id will cause the current depth buffer to be detached unless the old id and the new one are the same
Tells the target to update it's contents. If OGRE is not running in an automatic rendering loop (started using Root::startRenderingThis allows OGRE to be used in multi-windowed utilities and for contents to be refreshed only when required, rather than constantly as with the automatic rendering loop.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Bool | swapBuffers - For targets that support double-buffering, if set to true, the target will immediately swap it's buffers after update. Otherwise, the buffers are not swapped, and you have to call swapBuffers yourself sometime later. You might want to do this on some rendersystems which pause for queued rendering commands to complete before accepting swap buffers calls - so you could do other CPU tasks whilst the queued commands complete. Or, you might do this if you want custom control over your windows, such as for externally created windows. |
-> IO () |
Swaps the frame buffers to display the next frame. For targets that are double-buffered so that no 'in-progress' versions of the scene are displayed during rendering. Once rendering has completed (to an off-screen version of the window) the buffers are swapped to display the new frame.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Bool | waitForVSync - If true, the system waits for the next vertical blank period (when the CRT beam turns off as it travels from bottom-right to top-left at the end of the pass) before flipping. If false, flipping occurs no matter what the beam position. Waiting for a vertical blank can be slower (and limits the framerate to the monitor refresh rate) but results in a steadier image with no |
-> IO () |
Adds a viewport to the rendering target. A viewport is the rectangle into which rendering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> HG3DClass | cam - The camera from which the viewport contents will be rendered (mandatory) |
-> Int | ZOrder - The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher ZOrders are on top of lower ones. The actual number is irrelevant, only the relative ZOrder matters (you can leave gaps in the numbering) |
-> Float | left - The relative position of the left of the viewport on the target, as a value between 0 and 1. |
-> Float | top - The relative position of the top of the viewport on the target, as a value between 0 and 1. |
-> Float | width - The relative width of the viewport on the target, as a value between 0 and 1. |
-> Float | height - The relative height of the viewport on the target, as a value between 0 and 1. |
-> IO HG3DClass |
Returns the number of viewports attached to this target.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Int | index |
-> IO HG3DClass |
Retrieves a pointer to the viewport with the given index.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Int | ZOrder |
-> IO HG3DClass |
Retrieves a pointer to the viewport with the given zorder. throws if not found.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Int | ZOrder |
-> IO Bool |
Returns true if and only if a viewport exists at the given ZOrder.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Int | ZOrder |
-> IO () |
Removes all viewports on this target.
Removes a viewport at a given ZOrder.
Retieves details of current rendering performance. If the user application wishes to do it's own performance display, or use performance for some other means, this method allows it to retrieve the statistics.
Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering
Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering
Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering
Individual stats access - gets the best frame time
Individual stats access - gets the worst frame time
Removes all listeners from this instance.
Resets saved frame-rate statistices.
Used to retrieve or set the active state of the render target.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Bool | state |
-> IO () |
Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. By default, if you use OgreRoot::startRenderingRoot::_updateAllRenderTargets
Used to set the active state of the render target.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Bool | autoupdate - If true, the render target is updated during the automatic render loop or when Root::_updateAllRenderTargets is called. If false, the target is only updated when its update() method is called explicitly. |
-> IO () |
Gets whether this target is automatically updated if OgreRoot::_updateAllRenderTargets
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> String | filename |
-> IO () |
Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.
Writes the current contents of the render target to the named file.
Gets the number of triangles rendered in the last update()
Gets the number of batches rendered in the last update()
Indicates whether this target is the primary window. The primary window is special in that it is destroyed when ogre is shut down, and cannot be destroyed directly. This is the case because it holds the context for vertex, index buffers and textures.
Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. This is the exact opposite conversion of what is indicated by Texture::isHardwareGammaEnabled, and can only be enabled on creation of the render target. For render windows, it's enabled through the gamma
creation misc parameter. For textures, it is enabled through the hwGamma parameter to the create call.
Indicates whether multisampling is performed on rendering and at what level.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO String |
Gets the FSAA hint (Root::createRenderWindow
delete'_ :: HG3DClassPtr -> IO ()Source
getMetrics'_ :: HG3DClassPtr -> Ptr CUInt -> Ptr CUInt -> Ptr CUInt -> IO ()Source
getWidth'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()Source
getHeight'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()Source
getColourDepth'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()Source
setDepthBufferPool'_ :: HG3DClassPtr -> CUShort -> IO ()Source
getDepthBufferPool'_ :: HG3DClassPtr -> Ptr CUShort -> IO ()Source
detachDepthBuffer'_ :: HG3DClassPtr -> IO ()Source
update'_ :: HG3DClassPtr -> CInt -> IO ()Source
swapBuffers'_ :: HG3DClassPtr -> CInt -> IO ()Source
addViewport'_ :: HG3DClassPtr -> HG3DClassPtr -> CInt -> CFloat -> CFloat -> CFloat -> CFloat -> HG3DClassPtr -> IO ()Source
getNumViewports'_ :: HG3DClassPtr -> Ptr CUShort -> IO ()Source
getViewport'_ :: HG3DClassPtr -> CUShort -> HG3DClassPtr -> IO ()Source
getViewportByZOrder'_ :: HG3DClassPtr -> CInt -> HG3DClassPtr -> IO ()Source
hasViewportWithZOrder'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()Source
removeViewport'_ :: HG3DClassPtr -> CInt -> IO ()Source
removeAllViewports'_ :: HG3DClassPtr -> IO ()Source
getStatistics'_ :: HG3DClassPtr -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> Ptr CFloat -> IO ()Source
getLastFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getAverageFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getBestFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getWorstFPS'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getBestFrameTime'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getWorstFrameTime'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
resetStatistics'_ :: HG3DClassPtr -> IO ()Source
removeAllListeners'_ :: HG3DClassPtr -> IO ()Source
isActive'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
setActive'_ :: HG3DClassPtr -> CInt -> IO ()Source
setAutoUpdated'_ :: HG3DClassPtr -> CInt -> IO ()Source
isAutoUpdated'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
writeContentsToFile'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
writeContentsToTimestampedFile'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CChar -> Ptr CChar -> IO ()Source
requiresTextureFlipping'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getTriangleCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getBatchCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isPrimary'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isHardwareGammaEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getFSAAHint'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source