HGamer3D-Ogre-Binding-0.1.8: Library to enable 3D game development for Haskell - Ogre Bindings

Safe HaskellSafe-Infered

HGamer3D.Bindings.Ogre.ClassMaterial

Synopsis

Documentation

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

isTransparentSource

Arguments

:: HG3DClass

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

-> IO Bool 

Determines if the material has any transparency with the rest of the scene (derived from whether any Techniques say they involve transparency).

setReceiveShadowsSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Returns whether or not objects using this material will receive shadows.

Sets whether objects using this material will receive shadows. This method allows a material to opt out of receiving shadows, if it would otherwise do so. Shadows will not be cast on any objects unless the scene is set up to support shadows (SceneManager::setShadowTechniqueTransparent materials never receive shadows despite this setting. The default is to receive shadows.

getReceiveShadowsSource

Arguments

:: HG3DClass

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

-> IO Bool 

setTransparencyCastsShadowsSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Returns whether or not objects using this material be classified as opaque to the shadow caster system.

Sets whether objects using this material be classified as opaque to the shadow caster system. This method allows a material to cast a shadow, even if it is transparent. By default, transparent materials neither cast nor receive shadows. Shadows will not be cast on any objects unless the scene is set up to support shadows (SceneManager::setShadowTechnique

getTransparencyCastsShadowsSource

Arguments

:: HG3DClass

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

-> IO Bool 

getNumTechniquesSource

Arguments

:: HG3DClass

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

-> IO Int 

Retrieves the number of techniques.

removeTechniqueSource

Arguments

:: HG3DClass

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

-> Int

index

-> IO () 

Removes all the techniques in this Material

Removes the technique at the given index.

removeAllTechniquesSource

Arguments

:: HG3DClass

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

-> IO () 

Retrieves the number of supported techniques.

getNumSupportedTechniquesSource

Arguments

:: HG3DClass

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

-> IO Int 

getUnsupportedTechniquesExplanationSource

Arguments

:: HG3DClass

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

-> IO String 

Gets a string explaining why any techniques are not supported.

getNumLodLevelsSource

Arguments

:: HG3DClass

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

-> Int

schemeIndex

-> IO Int 

Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex. Note that this will not be up to date until the material has been compiled.

getNumLodLevels2Source

Arguments

:: HG3DClass

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

-> String

schemeName

-> IO Int 

Gets the number of levels-of-detail this material has in the given scheme, based on Technique::setLodIndex. Note that this will not be up to date until the material has been compiled.

cloneSource

Arguments

:: HG3DClass

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

-> String

newName - The name for the cloned material

-> Bool

changeGroup - If true, the resource group of the clone is changed

-> String

newGroup - Only required if changeGroup is true; the new group to assign

-> IO SharedPtr 

Creates a new copy of this material with the same settings but a new name.

copyDetailsToSource

Arguments

:: HG3DClass

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

-> IO SharedPtr

mat - Weak reference to material which will receive this material's settings.

Copies the details of this material into another, preserving the target's handle and name (unlike operator=) but copying everything else.

compileSource

Arguments

:: HG3DClass

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

-> Bool

autoManageTextureUnits - If true, when a fixed function pass has too many TextureUnitState entries than the card has texture units, the Pass in question will be split into more than one Pass in order to emulate the Pass. If you set this to false and this situation arises, an Exception will be thrown.

-> IO () 

Sets the point size properties for every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setPointSize

Compiles this MaterialCompiling a material involves determining which Techniques are supported on the card on which OGRE is currently running, and for fixed-function Passes within those Techniques, splitting the passes down where they contain more TextureUnitState instances than the current card has texture units. This process is automatically done when the Material

setPointSizeSource

Arguments

:: HG3DClass

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

-> Float

ps

-> IO () 

Sets the ambient colour reflectance properties for every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setAmbient

setAmbientSource

Arguments

:: HG3DClass

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

-> Float

red

-> Float

green

-> Float

blue

-> IO () 

Sets the ambient colour reflectance properties for every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setAmbient

setAmbient2Source

Arguments

:: HG3DClass

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

-> Colour

ambient

-> IO () 

Sets the diffuse colour reflectance properties of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setDiffuse

setDiffuseSource

Arguments

:: HG3DClass

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

-> Float

red

-> Float

green

-> Float

blue

-> Float

alpha

-> IO () 

Sets the diffuse colour reflectance properties of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setDiffuse

setDiffuse2Source

Arguments

:: HG3DClass

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

-> Colour

diffuse

-> IO () 

Sets the specular colour reflectance properties of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setSpecular

setSpecularSource

Arguments

:: HG3DClass

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

-> Float

red

-> Float

green

-> Float

blue

-> Float

alpha

-> IO () 

Sets the specular colour reflectance properties of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setSpecular

setSpecular2Source

Arguments

:: HG3DClass

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

-> Colour

specular

-> IO () 

Sets the shininess properties of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setShininess

setShininessSource

Arguments

:: HG3DClass

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

-> Float

val

-> IO () 

Sets the amount of self-illumination of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setSelfIllumination

setSelfIlluminationSource

Arguments

:: HG3DClass

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

-> Float

red

-> Float

green

-> Float

blue

-> IO () 

Sets the amount of self-illumination of every Pass in every Technique. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setSelfIllumination

setSelfIllumination2Source

Arguments

:: HG3DClass

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

-> Colour

selfIllum

-> IO () 

Sets whether or not each Pass renders with depth-buffer checking on or not. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setDepthCheckEnabled

setDepthCheckEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Sets whether or not each Pass renders with depth-buffer writing on or not. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setDepthWriteEnabled

setDepthWriteEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Sets whether or not colour buffer writing is enabled for each Pass. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setColourWriteEnabled

setColourWriteEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Sets whether or not dynamic lighting is enabled for every Pass. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setLightingEnabled

setLightingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled

-> IO () 

Sets the depth bias to be used for each Pass. This property has been moved to the Pass class, which is accessible via the Technique. For simplicity, this method allows you to set these properties for every current Technique, and for every current Pass within those Techniques. If you need more precision, retrieve the Technique and Pass instances and set the property there. Pass::setDepthBias

setDepthBiasSource

Arguments

:: HG3DClass

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

-> Float

constantBias

-> Float

slopeScaleBias

-> IO () 

Sets the anisotropy level to be used for all textures. This property has been moved to the TextureUnitState class, which is accessible via the Technique and Pass. For simplicity, this method allows you to set these properties for every current TeextureUnitState, If you need more precision, retrieve the Technique, Pass and TextureUnitState instances and set the property there. TextureUnitState::setTextureAnisotropy

setTextureAnisotropySource

Arguments

:: HG3DClass

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

-> Int

maxAniso

-> IO () 

Touches the resource to indicate it has been used.

touchSource

Arguments

:: HG3DClass

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

-> IO () 

Gets the compilation status of the material.

getCompilationRequiredSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - True if the material needs recompilation.