HGamer3D-Ogre-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - Ogre Bindings

Safe HaskellNone

HGamer3D.Bindings.Ogre.ClassRenderWindow

Synopsis

Documentation

setFullscreenSource

Arguments

:: HG3DClass

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

-> Bool

fullScreen - Whether to use fullscreen mode or not.

-> Int

width - The new width to use

-> Int

height - The new height to use

-> IO () 

Destroys the window.

Alter fullscreen mode options. Nothing will happen unless the settings here are different from the current settings.

destroySource

Arguments

:: HG3DClass

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

-> IO () 

Alter the size of the window.

resizeSource

Arguments

:: HG3DClass

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

-> Int

width

-> Int

height

-> IO () 

Notify that the window has been resized You don't need to call this unless you created the window externally.

windowMovedOrResizedSource

Arguments

:: HG3DClass

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

-> IO () 

Reposition the window.

repositionSource

Arguments

:: HG3DClass

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

-> Int

left

-> Int

top

-> IO () 

Indicates whether the window is visible (not minimized or obscured)

isVisibleSource

Arguments

:: HG3DClass

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

-> IO Bool 

setVisibleSource

Arguments

:: HG3DClass

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

-> Bool

visible

-> IO () 

Indicates whether the window was set to hidden (not displayed)

Set the visibility state

isHiddenSource

Arguments

:: HG3DClass

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

-> IO Bool 

setHiddenSource

Arguments

:: HG3DClass

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

-> Bool

hidden

-> IO () 

Enable or disable vertical sync for the RenderWindow

Hide (or show) the window. If called with hidden=true, this will make the window completely invisible to the user. Setting a window to hidden is useful to create a dummy primary RenderWindow

setVSyncEnabledSource

Arguments

:: HG3DClass

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

-> Bool

vsync

-> IO () 

Indicates whether vertical sync is activated for the window.

isVSyncEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

setVSyncIntervalSource

Arguments

:: HG3DClass

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

-> Int

interval

-> IO () 

Returns the vertical sync interval.

Set the vertical sync interval. This indicates the number of vertical retraces to wait for before swapping buffers. A value of 1 is the default.

getVSyncIntervalSource

Arguments

:: HG3DClass

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

-> IO Int 

isActiveSource

Arguments

:: HG3DClass

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

-> IO Bool 

Overridden from RenderTarget

isClosedSource

Arguments

:: HG3DClass

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

-> IO Bool 

Indicates whether the window has been closed by the user.

isPrimarySource

Arguments

:: HG3DClass

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

-> IO Bool 

Indicates whether the window 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.

isFullScreenSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns true if window is running in fullscreen mode.

getMetricsSource

Arguments

:: HG3DClass

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

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

width

Overloaded version of getMetrics from RenderTarget

isDeactivatedOnFocusChangeSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns true if the window will automatically de-activate itself when it loses focus.

setDeactivateOnFocusChangeSource

Arguments

:: HG3DClass

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

-> Bool

deactivate - a value of true will cause the window to deactivate itself when it loses focus. false will allow it to continue to render even when window focus is lost.

-> IO () 

Indicates whether the window will automatically deactivate itself when it loses focus. true is the default behavior.