pantson.Theora v2.2 |
| pantson.theora: | Functions | Types | Modinfo |
| CloseTheora | Close a movie and sets to NULL. |
| DrawTheora | OBSOLETE. |
| DrawTheoraImage | Draws a theora movie onto an image frame. |
| DrawTheoraPixmap | Draws a theora movie onto a pixamp. |
| EOT | Check to see if a Theora movie has ended. |
| OpenTheora | Opens a Theora file ready for drawing. |
| PauseTheora | Pauses or unpauses a theora movie. |
| PlayTheora | Plays a theora movie at co-ords x and y. specific width and height and if it should keep the aspect ratio when drawing. |
| ProcessTheora | Process a theora thread. If passed NULL (default) all theora threads are processed. |
| StartTheora | Gets a Theora movie ready for drawing. Can only be started from the beginning of a Theora movie. |
| TheoraFullscreen | Set the drawing scale so that the Theora movie will fit the full screen. |
| TheoraHeight | Get height of a theora movie. |
| TheoraWidth | Get width of theora movie. |
| Ttheora | Theora movie type. |
| Function CloseTheora:Int(movie:Ttheora) | |
| Returns | Once closed the movie cannot be drawn. |
| Description | Close a movie and sets to NULL. |
| Function DrawTheora:Int(movie:Ttheora,pixmap:TPixmap=Null) | |
| Returns | Error message about command set. |
| Description | OBSOLETE. |
| Function DrawTheoraImage:Int(theora:Ttheora,image:Timage,frame:Int=0) | |
| Returns | True if an update to the image occoured. |
| Description | Draws a theora movie onto an image frame. |
| Function DrawTheoraPixmap:Int(theora:Ttheora,pixmap:TPixmap) | |
| Returns | True if an update to the pixamp occoured. |
| Description | Draws a theora movie onto a pixamp. |
| Function EOT:Int(movie:Ttheora) | |
| Returns | True if end of Theora, false otherwise. |
| Description | Check to see if a Theora movie has ended. |
| Function OpenTheora:Ttheora(filename:String,buffersize:Int=4096) | |
| Returns | A handle to the Theora movie. NULL if the file doesn't exist. |
| Description | Opens a Theora file ready for drawing. |
| Function PauseTheora:Int(movie:Ttheora) | |
| Returns | true if paused. false if resumed. |
| Description | Pauses or unpauses a theora movie. |
| Function PlayTheora:Int(filename:String,x:Int=0,y:Int=0,w:Int=0,h:Int=0,aspect:Int=False) | |
| Returns | True if the movie was drawn. |
| Description | Plays a theora movie at co-ords x and y. specific width and height and if it should keep the aspect ratio when drawing. |
| Function ProcessTheora:Int(movie:Ttheora=Null) | |
| Returns | True if an update to a frame exists. |
| Description | Process a theora thread. If passed NULL (default) all theora threads are processed. |
| Function StartTheora:Int(movie:Ttheora,seconds:Float=0) | |
| Returns | true. |
| Description | Gets a Theora movie ready for drawing. Can only be started from the beginning of a Theora movie. |
| Function TheoraFullscreen:Int(movie:Ttheora) | |
| Returns | This function auto calls the setscale command. Any drawing commands after setting this value will be affected too. |
| Description | Set the drawing scale so that the Theora movie will fit the full screen. |
| Function TheoraHeight:Int(movie:Ttheora,width:Int=Null) | |
| Returns | The height. If provided with a width, it will Return a value that is in proportion. |
| Description | Get height of a theora movie. |
| Function TheoraWidth:Int(movie:Ttheora,height:Int=Null) | |
| Returns | The width. If provided with a height, it will return a value that is in proportion. |
| Description | Get width of theora movie. |
| Type Ttheora | |
| Description | Theora movie type. |
| Methods Summary | |
|---|---|
| draw | Check to see if a frame has been drawn on the specified pixmap. |
| pause | Pauses or unpauses a theora movie. |
| start | Gets a Theora movie ready for drawing. Can only be started from the beginning of a Theora movie. |
| Method draw:Int() | |
| Returns | True if a frame has been drawn. |
| Description | Check to see if a frame has been drawn on the specified pixmap. |
| Method pause:Int() | |
| Returns | true if paused. false if resumed. |
| Description | Pauses or unpauses a theora movie. |
| Method start(t:Float=0) | |
| Returns | true. |
| Description | Gets a Theora movie ready for drawing. Can only be started from the beginning of a Theora movie. |
| Version | 2.1 |
|---|---|
| Author | Richard Hanson (PantsOn) |
| Modserver | pantson |
| Testing | Brucey, James Rozee |
| Theora | Just enough for me and my dawg |
| CC_OPTS | -D__MACOSX__ |