HGamer3D.Bindings.CEGUI.ClassImageset

Documentation

new

Arguments

:: String

name - String object holding the name to be assigned to the created imageset.

-> String

filename - String object holding the filename of the image that is to be loaded. The image should be of some format that is supported by the Renderer that is in use.

-> String

resourceGroup - Resource group identifier to be passed to the resource manager, which may specify a group from which the image file is to be loaded.

-> IO HG3DClass

Construct a new Imageset - Details: Under certain renderers it may be required that the source image dimensions be some power of 2, if this condition is not met then stretching and other undesired side-effects may be experienced. To be safe from such effects it is generally recommended that all images that you load have dimensions that are some power of 2.

delete

Arguments

:: HG3DClass

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

-> IO ()

return String object holding the name of the Imageset

Destroys Imageset

getName

Arguments

:: HG3DClass

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

-> IO String

return value - String object that holds the name of the

getImageCount

Arguments

:: HG3DClass

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

-> IO Int

return value - uint value equal to the number of Image objects defined for the

return number of images defined for this Imageset

isImageDefined

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image to look for.

-> IO Bool

return value - true if an Image object named

return true if an Image with the specified name exists.

undefineImage

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image object to be removed from the Imageset,

-> IO ()

return value - Nothing.

Removes the definitions for all Image objects currently defined in the Imageset

remove the definition for the Image with the specified name. If no such Image exists, nothing happens.

undefineAllImages

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

return the width of the named image.

getImageWidth

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image.

-> IO Float

return value - float value equalling the width of the requested Image.

getImageHeight

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image.

-> IO Float

return value - float value equalling the height of the requested Image.

return the height of the named image.

getImageOffsetX

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image.

-> IO Float

return value - float value equal to the x rendering offset applied when drawing the requested Image.

return the x rendering offset for the named image.

getImageOffsetY

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Image.

-> IO Float

return value - float value equal to the y rendering offset applied when drawing the requested Image.

return the y rendering offset for the named image.

isAutoScaled

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if

Return whether this Imageset

setAutoScalingEnabled

Arguments

:: HG3DClass

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

-> Bool

setting - true to enable auto-scaling, false to disable auto-scaling.

-> IO ()

return value - Nothing.

Sets the default resource group to be used when loading imageset data.

Enable or disable auto-scaling for this Imageset

setDefaultResourceGroup

Arguments

:: String

resourceGroup - String describing the default resource group identifier to be used.

-> IO ()

return value - Nothing.

Returns the default resource group currently set for Imagesets.

getDefaultResourceGroup

Arguments

:: IO String

return value - String describing the default resource group identifier that will be used when loading

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

delete'_ :: HG3DClassPtr -> IO ()

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

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

isImageDefined'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CInt -> IO ()

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

undefineAllImages'_ :: HG3DClassPtr -> IO ()

getImageWidth'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CFloat -> IO ()

getImageHeight'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CFloat -> IO ()

getImageOffsetX'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CFloat -> IO ()

getImageOffsetY'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CFloat -> IO ()

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

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

setDefaultResourceGroup'_ :: Ptr CChar -> IO ()

getDefaultResourceGroup'_ :: Ptr CChar -> IO ()