HGamer3D.Bindings.Ogre.ClassViewport

Documentation

new

Arguments

:: HG3DClass

camera

-> HG3DClass

target - Pointer to the render target to be the destination for the rendering.

-> Float

left

-> Float

top

-> Float

width

-> Float

height - Dimensions of the viewport, expressed as a value between 0 and 1. This allows the dimensions to apply irrespective of changes in the target's size: e.g. to fill the whole area, values of 0,0,1,1 are appropriate.

-> Int

ZOrder - Relative Z-order on the target. Lower = further to the front.

-> IO HG3DClass

The usual constructor.

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Instructs the viewport to updates its contents.

Default destructor.

update

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Instructs the viewport to clear itself, without performing an update. You would not normally call this method when updating the viewport, since the viewport usually clears itself when updating anyway (Viewport::setClearEveryFrame

clear

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

buffers - Bitmask identifying which buffer elements to clear

-> Colour

colour - The colour value to clear to, if FBT_COLOUR is included

-> Float

depth - The depth value to clear to, if FBT_DEPTH is included

-> Int

stencil - The stencil value to clear to, if FBT_STENCIL is included

-> IO ()

Retrieves a pointer to the render target for this viewport.

getTarget

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

getCamera

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

Retrieves a pointer to the camera for this viewport.

setCamera

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

cam

-> IO ()

Gets the Z-Order of this viewport.

Sets the camera to use for rendering to this viewport.

getZOrder

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

getLeft

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.

getTop

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.

getWidth

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.

getHeight

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

Gets one of the relative dimensions of the viewport, a value between 0.0 and 1.0.

getActualLeft

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Gets one of the actual dimensions of the viewport, a value in pixels.

getActualTop

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Gets one of the actual dimensions of the viewport, a value in pixels.

getActualWidth

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Gets one of the actual dimensions of the viewport, a value in pixels.

getActualHeight

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Gets one of the actual dimensions of the viewport, a value in pixels.

setDimensions

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

left

-> Float

top

-> Float

width

-> Float

height - Dimensions relative to the size of the target, represented as real values between 0 and 1. i.e. the full target area is 0, 0, 1, 1.

-> IO ()

Set the orientation mode of the viewport.

Sets the dimensions (after creation).

setOrientationMode

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> EnumOrientationMode

orientationMode

-> Bool

setDefault

-> IO ()

Get the orientation mode of the viewport.

getOrientationMode

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO EnumOrientationMode

setBackgroundColour

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Colour

colour

-> IO ()

Gets the background colour.

Sets the initial background colour of the viewport (before rendering).

getBackgroundColour

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Colour

setDepthClear

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

depth

-> IO ()

Gets the default depth buffer value to which the viewport is cleared.

Sets the initial depth buffer value of the viewport (before rendering). Default is 1

getDepthClear

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Float

setClearEveryFrame

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

clear - Whether or not to clear any buffers

-> Int

buffers - One or more values from FrameBufferType denoting which buffers to clear, if clear is set to true. Note you should not clear the stencil buffer here unless you know what you're doing.

-> IO ()

Determines if the viewport is cleared before every frame.

Determines whether to clear the viewport before rendering. You can use this method to set which buffers are cleared (if any) before rendering every frame.

getClearEveryFrame

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

getClearBuffers

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Gets which buffers are to be cleared each frame.

setAutoUpdated

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

autoupdate - If true, the viewport is updated during the automatic render loop or when RenderTarget::update() is called. If false, the viewport is only updated when its update() method is called explicitly.

-> IO ()

Gets whether this viewport is automatically updated if OgreRenderTarget::update

Sets whether this viewport should be automatically updated if Ogre's rendering loop or RenderTarget::update is being used. By default, if you use OgreRoot::startRenderingRenderTarget::update

isAutoUpdated

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setMaterialScheme

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

schemeName

-> IO ()

Get the material scheme which the viewport should use.

Set the material scheme which the viewport should use. This allows you to tell the system to use a particular material scheme when rendering this viewport, which can involve using different techniques to render your materials. Technique::setSchemeName

getMaterialScheme

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

getActualDimensions

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO (Int, Int, Int, Int)

left

Access to actual dimensions (based on target size).

setOverlaysEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

enabled - If true, any overlays are displayed, if false they are not.

-> IO ()

Returns whether or not Overlay objects (created in the SceneManager

Tells this viewport whether it should display Overlay objects. Overlay objects are layers which appear on top of the scene. They are created via SceneManager::createOverlay and every viewport displays these by default. However, you probably don't want this if you're using multiple viewports, because one of them is probably a picture-in-picture which is not supposed to have overlays of it's own. In this case you can turn off overlays on this viewport by calling this method.

getOverlaysEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setSkiesEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

enabled - If true, any skies are displayed, if false they are not.

-> IO ()

Returns whether or not skies (created in the SceneManager

Tells this viewport whether it should display skies. Skies are layers which appear on background of the scene. They are created via SceneManager::setSkyBoxSceneManager::setSkyPlaneSceneManager::setSkyDome

getSkiesEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setShadowsEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

enabled - If true, any shadows are displayed, if false they are not.

-> IO ()

Returns whether or not shadows (defined in the SceneManager

Tells this viewport whether it should display shadows. This setting enables you to disable shadow rendering for a given viewport. The global shadow technique set on SceneManager

getShadowsEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

setVisibilityMask

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

mask

-> IO ()

Gets a per-viewport visibility mask. Viewport::setVisibilityMask

Sets a per-viewport visibility mask. The visibility mask is a way to exclude objects from rendering for a given viewport. For each object in the frustum, a check is made between this mask and the objects visibility flags (MovableObject::setVisibilityFlags

getVisibilityMask

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Sets the use of a custom RenderQueueInvocationSequence for rendering this target. RenderQueueInvocationSequence instances are managed through RootRenderTargetRoot

setRenderQueueInvocationSequenceName

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

sequenceName

-> IO ()

Gets the name of the render queue invocation sequence for this target.

getRenderQueueInvocationSequenceName

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

pointOrientedToScreen

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Vec2

v

-> Int

orientationMode

-> IO Vec2

outv

Convert oriented input point coordinates to screen coordinates.

pointOrientedToScreen2

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Float

orientedX

-> Float

orientedY

-> Int

orientationMode

-> IO (Float, Float)

screenX

setDefaultOrientationMode

Arguments

:: EnumOrientationMode

orientationMode

-> IO ()

Get the initial orientation mode of viewports.

Set the initial orientation mode of viewports.

getDefaultOrientationMode

Arguments

:: IO EnumOrientationMode

new'_ :: HG3DClassPtr -> HG3DClassPtr -> CFloat -> CFloat -> CFloat -> CFloat -> CInt -> HG3DClassPtr -> IO ()

delete'_ :: HG3DClassPtr -> IO ()

update'_ :: HG3DClassPtr -> IO ()

clear'_ :: HG3DClassPtr -> CUInt -> ColourPtr -> CFloat -> CUShort -> IO ()

getTarget'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

getCamera'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

setCamera'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

getZOrder'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getLeft'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

getTop'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

getWidth'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

getHeight'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

getActualLeft'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getActualTop'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getActualWidth'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getActualHeight'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setDimensions'_ :: HG3DClassPtr -> CFloat -> CFloat -> CFloat -> CFloat -> IO ()

setOrientationMode'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()

getOrientationMode'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setBackgroundColour'_ :: HG3DClassPtr -> ColourPtr -> IO ()

getBackgroundColour'_ :: HG3DClassPtr -> ColourPtr -> IO ()

setDepthClear'_ :: HG3DClassPtr -> CFloat -> IO ()

getDepthClear'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()

setClearEveryFrame'_ :: HG3DClassPtr -> CInt -> CUInt -> IO ()

getClearEveryFrame'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getClearBuffers'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

setAutoUpdated'_ :: HG3DClassPtr -> CInt -> IO ()

isAutoUpdated'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setMaterialScheme'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getMaterialScheme'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getActualDimensions'_ :: HG3DClassPtr -> Ptr CInt -> Ptr CInt -> Ptr CInt -> Ptr CInt -> IO ()

setOverlaysEnabled'_ :: HG3DClassPtr -> CInt -> IO ()

getOverlaysEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setSkiesEnabled'_ :: HG3DClassPtr -> CInt -> IO ()

getSkiesEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setShadowsEnabled'_ :: HG3DClassPtr -> CInt -> IO ()

getShadowsEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setVisibilityMask'_ :: HG3DClassPtr -> CUInt -> IO ()

getVisibilityMask'_ :: HG3DClassPtr -> Ptr CUInt -> IO ()

setRenderQueueInvocationSequenceName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getRenderQueueInvocationSequenceName'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

pointOrientedToScreen'_ :: HG3DClassPtr -> Vec2Ptr -> CInt -> Vec2Ptr -> IO ()

pointOrientedToScreen2'_ :: HG3DClassPtr -> CFloat -> CFloat -> CInt -> Ptr CFloat -> Ptr CFloat -> IO ()

setDefaultOrientationMode'_ :: CInt -> IO ()

getDefaultOrientationMode'_ :: Ptr CInt -> IO ()