pyropixel.ppsoftshadow: Types Modinfo Source  

PPSoftshadow

Fields

Field colB = 255
DescriptionPPAmbientLight's blue value.

Field colG = 255
DescriptionPPAmbientLight's green value.

Field colR = 255
DescriptionPPAmbientLight's red value.

Field isOn
DescriptionWhether PPAmbientLight is on or off.
InformationSet this value to true so that an ambient light is rendered.

Types

Type PPSoftshadow
DescriptionPPSoftshadow Type.
Function EditorOld()
Returnsnothing.
DescriptionThe inline Editor.
InformationUse this Function call in your Main Loop if you want to use the inline Editor.
The inline Editor lets you create and control shadow and light objects easily.
Function GetDebugMode()
Returns0 if DebugMode is off
1 if DebugMode is on.
DescriptionCheck if PPSoftshadow's DebugMode is on or off.
InformationYou could use this when using the inline editor.
Function GetEditorMode()
Returns0 if Editor is off
1 if Editor is on.
DescriptionCheck if PPSoftshadow's inline Editor is on or off.
InformationYou could use this when using the inline editor. For example the inline Editor uses arrow keys to move a selected item. If your Application does use arrow keys in main loop too, you could deactivate them when you know that the Editor is active.
Function MinimiseEditor(_bool:Byte)
Returnsnothing.
DescriptionMinimise PPSoftshadow's Editor Windows.
InformationYou could use this to let editor windows start minimised i.e.
True minimises windows
False maximises windows
Function SetDebugMode( _mode )
Returnsnothing.
DescriptionSet PPSoftshadow's DebugMode on or off.
InformationYou could use this when using the inline editor.
0 sets DebugMode off
1 sets Debugmode on.
Function SetEditorMode( _mode )
Returnsnothing.
DescriptionSet PPSoftshadow's Editor on or off.
InformationYou could use this when using the inline editor.
0 sets Editor off
1 sets Editor on
Function SetOffset(_x,_y)
Returnsnothing.
DescriptionSets the offset for all shadow casters and lights. _x and _y are the current offsets.
InformationThis is handy for scrolling levels, tilemaps etc. so that the shadows will scroll too.
Function UpdateLights()
Returnsnothing.
DescriptionUpdates all light calculations and drawings.
InformationUse this after drawing the objects taht throw shadows in your main loop.
Function UpdateShadows()
Returnsnothing.
DescriptionUpdates all shadow calculations and drawings.
InformationUse this after drawing the ground in your main loop.

Type TLight
DescriptionTLight Type.
Function Create:TLight(_x#,_y#,_radius=1,_mouseposition=False,_r=255,_g=255,_b=255,_alpha#=1, _scale#=1, _softshadows=False, _randomradius=0,_flickering=2.5,_z#=2,_intensity#=0.5, _lensflare=False, _flarecount=4, _flareintensity#=0.5)
DescriptionCreates a new TLight Object.
Information_x# _y# _radius=1 _mouseposition=False _r=255,_g=255 _b=255 _alpha#=1 _scale#=1 _softshadows=False _randomradius=0 _flickering=5 _z#=2 _intensity#=0.5.
Function UpdateAll()
DescriptionUpdates all TLight Objects.

Module Information

Version1.04 - 8th July 2006
AuthorRene Aye mailto:raye@pyroplay.de - Visit http://www.pyroplay.de
AuthorIndiepaths texturedpoly mod is used in DirectX - http://modules.indiepath.com/
LicenseFree to use BlitzMax module
History1.04 Release
HistoryFixed: editor light object positioning with offset values
History1.03 Release
HistoryFixed: editor crashed when no lights and no shadow objects are in the project
HistoryFixed: SetOffset() did not move the lightcones, flares etc.
HistoryEditor: Light Tab, editfields do work now
History1.02 Release
HistoryAdded DirectX compatability
HistoryFixed Editor bug: creating vectors although no SCO is selected
History1.01 Release
Historyfixed some TList = null editor crashes
Historyadded help window
History1.00 Release
Historyfixed memory leakage
Historyinline editor rewritten, GUI system added
Historylens flare system
Historycircle shadow caster added
Historyshadow caster rotation
Historyoffset values for integrating into scrolling games
Historyambient light control