-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
114 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# LoadVideo | ||
# LoadVideo <small>(RSDKv3)</small> | ||
|
||
## Description | ||
Loads and plays a video. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# LoadImage | ||
|
||
## Description | ||
Loads and displays an image. | ||
|
||
## Parameters | ||
`filename` | ||
|
||
: The file path of the image to load, relative to `Data/Images/`. Images may **ONLY** be in PNG format and **MUST** have a resolution of 1024x512 pixels. | ||
|
||
!!! note | ||
Prior to REV02, RSDKv5 used the TGA format for images instead of PNG. | ||
|
||
`displayLength` | ||
|
||
: The amount of time, in seconds, to show the image on-screen (excluding the time during fading in/out). | ||
|
||
`fadeSpeed` | ||
|
||
: The amount of time, in seconds, to take for the image to fade in/out. | ||
|
||
`skipCallback` | ||
|
||
: The function that will be called every frame the image is shown to determine if it should be skipped. The function must return a `bool32` value. Setting this to `NULL` will make the image unskippable. | ||
|
||
## Return Value | ||
None. | ||
|
||
## Syntax | ||
=== "C" | ||
|
||
``` c | ||
RSDK.LoadImage(const char *filename, double displayLength, double fadeSpeed, bool32 (*skipCallback)()) | ||
``` | ||
|
||
=== "C++" | ||
|
||
``` cpp | ||
Video::LoadImage(const char *filename, double displayLength, double fadeSpeed, bool32 (*skipCallback)()) | ||
``` | ||
|
||
## Example | ||
=== "C" | ||
|
||
``` c | ||
RSDK.LoadImage("Image.png", 32.0, 1.0, MyObject_ImageSkipCB); | ||
``` | ||
|
||
=== "C++" | ||
|
||
``` cpp | ||
Video::LoadImage("Image.png", 32.0, 1.0, ImageSkipCB); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# LoadVideo <small>(RSDKv5)</small> | ||
|
||
## Description | ||
Loads and plays a video. | ||
|
||
## Parameters | ||
`filename` | ||
|
||
: The file path of the video to load, relative to `Data/Videos/`. Videos may **ONLY** be in OGV format. | ||
|
||
`startDelay` | ||
|
||
: The amount of time, in seconds, to wait before playing the video after loading it. | ||
|
||
`skipCallback` | ||
|
||
: The function that will be called every frame during the video to determine if it should be skipped. The function must return a `bool32` value. Setting this to `NULL` will make the video unskippable. | ||
|
||
## Return Value | ||
Returns `true` as a `bool32` if the video loaded successfully; otherwise, returns `false`. | ||
|
||
## Syntax | ||
=== "C" | ||
|
||
``` c | ||
RSDK.LoadVideo(const char *filename, double startDelay, bool32 (*skipCallback)()); | ||
``` | ||
|
||
=== "C++" | ||
|
||
``` cpp | ||
Video::LoadVideo(const char *filename, double startDelay, bool32 (*skipCallback)()); | ||
``` | ||
|
||
## Example | ||
=== "C" | ||
|
||
``` c | ||
RSDK.LoadVideo("Opening.ogv", 0.0, MyObject_VideoSkipCB); | ||
``` | ||
|
||
=== "C++" | ||
|
||
``` cpp | ||
Video::LoadVideo("Opening.ogv", 0.0, VideoSkipCB); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters