RFK
Types
EventInfo | |
TutorialApplication | |
UserVariable | |
EVENT |
|
EVENT_FLAG |
|
EVENT_ERROR |
|
INSPECTOR |
|
UVAR_TYPE |
|
UVAR_WIDGET |
|
KEYBOARD_KEY |
|
LOOP_MODE |
|
CHOICE |
Type Aliases
RED_RC (* |
EVENT_CALLBACK |
RED_RC (* |
COMMAND_CALLBACK |
Fields
EVT_ERROR |
|
EVT_INIT |
|
EVT_UPDATE |
|
EVT_RENDER_COMPLETE |
|
EVT_CLOSE |
|
EVT_RESIZE |
|
EVT_PAINT |
|
EVT_MOUSE |
|
EVT_KEY_PRESSED |
|
EVT_KEY_RELEASED |
|
EVT_UVAR |
|
EVT_DRAG_ENTER |
|
EVT_DROP_FILE |
|
EVT_ITEM_SELECT |
|
EVT_CLOSE_INSPECTOR |
|
EVT_COUNT |
|
EVT_FLAG_ERROR |
|
EVT_FLAG_MOUSE_POS |
|
EVT_FLAG_MOUSE_BUTTONS |
|
EVT_FLAG_MOUSE_WHEEL |
|
EVT_FLAG_KEY |
|
EVT_FLAG_RESIZE |
|
EVT_FLAG_UVAR |
|
EVT_FLAG_PATH |
|
EVT_ERR_NO_NETWORK |
|
EVT_ERR_DOWNLOAD_FAILED |
|
EVT_ERR_MISSING_DEPENDENCY |
|
IPR_GEOMETRY |
|
IPR_UVAR |
|
IPR_TONEMAPPING |
|
IPR_PERFORMANCE |
|
IPR_SCENEGRAPH |
|
IPR_MEMORY |
|
IPR_LIGHT |
|
IPR_MATERIAL |
|
IPR_TRANSFORM |
|
IPR_VIEWPOINT |
|
UVT_BOOL |
|
UVT_CHAR |
|
UVT_SHORT |
|
UVT_INT |
|
UVT_FLOAT |
|
UVT_DOUBLE |
|
UVT_STRING |
|
UVT_LIST |
|
UVT_FILE |
|
UVW_SLIDER |
|
UVW_EDIT |
|
UVW_VIEW |
|
KEY_ESCAPE |
|
KEY_TAB |
|
KEY_RETURN |
|
KEY_SPACE |
|
KEY_SHIFT |
|
KEY_LEFT |
|
KEY_UP |
|
KEY_RIGHT |
|
KEY_DOWN |
|
KEY_LSHIFT |
|
KEY_LCTRL |
|
KEY_MINUS |
|
KEY_PLUS |
|
LM_ACTIVE |
|
LM_PASSIVE |
|
LM_SOFTWARE_BY_SURFACE |
|
LM_SOFTWARE_BY_BLOCKS |
|
LM_SOFTWARE_PATH_TRACING |
|
LM_CUSTOM |
|
LM_CONSOLE |
|
YES |
|
NO |
|
OK |
|
CANCEL |
Type Documentation
-
enum
RFK::
EVENT
Lists the supported application events.
Values:
-
enumerator
EVT_ERROR
This event occurs after an error in the application.
-
enumerator
EVT_INIT
This event occurs after the framework is initialized and before the application window content is drawn for the first time.
-
enumerator
EVT_UPDATE
This event occurs at each main loop frame before the rendering.
-
enumerator
EVT_RENDER_COMPLETE
This event occurs once the rendering is done in software modes or after each RED::IWindow::FrameDrawing in hardware modes.
-
enumerator
EVT_CLOSE
This event occurs just before the application is closed.
-
enumerator
EVT_RESIZE
This event occurs after a resize of the application window.
-
enumerator
EVT_PAINT
This event occurs each time the application window is drawn.
-
enumerator
EVT_MOUSE
This event occurs each time the mouse is used (including mouse move and mouse button events).
-
enumerator
EVT_KEY_PRESSED
This event occurs each time a keyboard key is pressed.
-
enumerator
EVT_KEY_RELEASED
This event occurs each time a keyboard key is released.
-
enumerator
EVT_UVAR
This event occurs when a user variable is modified.
-
enumerator
EVT_DRAG_ENTER
This event occurs when a single file is dragged and the mouse cursor enters the application layout. The application must reject or accept the drag operation by clearing or not the dragged file path.
-
enumerator
EVT_DROP_FILE
A file has been dropped over the application after the acceptance of the corresponding EVT_DRAG_ENTER event.
-
enumerator
EVT_ITEM_SELECT
An object has been selected. It could be from any inspector.
-
enumerator
EVT_CLOSE_INSPECTOR
-
enumerator
EVT_COUNT
-
enumerator
-
enum
RFK::
EVENT_FLAG
Describes the meaningful fields in a EventInfo structure. The _flags value in an EventInfo variable can be any combination of the following flags.
Values:
-
enumerator
EVT_FLAG_ERROR
The “_error” and “_error_string” fields are valid.
-
enumerator
EVT_FLAG_MOUSE_POS
The “_mouse_x” and “_mouse_y” fields are valid.
-
enumerator
EVT_FLAG_MOUSE_BUTTONS
The “_mouse_left”, “_mouse_right” and “_mouse_middle” fields are valid.
-
enumerator
EVT_FLAG_MOUSE_WHEEL
The “_mouse_wheel” is valid.
-
enumerator
EVT_FLAG_KEY
The “_key” is valid.
-
enumerator
EVT_FLAG_RESIZE
The “_win_width” and “_win_height” fields are valid.
-
enumerator
EVT_FLAG_UVAR
The “_uvar” field is valid.
-
enumerator
EVT_FLAG_PATH
The “_path” field is valid (set by a EVT_DRAG_ENTER or EVT_DROP_FILE event).
-
enumerator
-
enum
RFK::
EVENT_ERROR
Describes the type of errors that can be set in a EVT_ERROR event.
Values:
-
enumerator
EVT_ERR_NO_NETWORK
A network connection is needed but can’t be initialiazed.
-
enumerator
EVT_ERR_DOWNLOAD_FAILED
A download operation has failed.
-
enumerator
EVT_ERR_MISSING_DEPENDENCY
A needed application dependency is missing.
-
enumerator
-
enum
RFK::
INSPECTOR
Describes the available inspectors.
Values:
-
enumerator
IPR_GEOMETRY
Geometry inspector.
-
enumerator
IPR_UVAR
User variables inspector.
-
enumerator
IPR_TONEMAPPING
Tone mapping parameters inspector.
-
enumerator
IPR_PERFORMANCE
Performance inspector.
-
enumerator
IPR_SCENEGRAPH
Scene graph inspector.
-
enumerator
IPR_MEMORY
Memory inspector.
-
enumerator
IPR_LIGHT
Light inspector.
-
enumerator
IPR_MATERIAL
Material inspector.
-
enumerator
IPR_TRANSFORM
Transform inspector.
-
enumerator
IPR_VIEWPOINT
Viewpoint inspector.
-
enumerator
-
enum
RFK::
UVAR_TYPE
Describes the various user variable types.
Values:
-
enumerator
UVT_BOOL
-
enumerator
UVT_CHAR
-
enumerator
UVT_SHORT
-
enumerator
UVT_INT
-
enumerator
UVT_FLOAT
-
enumerator
UVT_DOUBLE
-
enumerator
UVT_STRING
-
enumerator
UVT_LIST
-
enumerator
UVT_FILE
-
enumerator
-
enum
RFK::
UVAR_WIDGET
Describes the various user variable widgets.
Values:
-
enumerator
UVW_SLIDER
Uses a slider to edit the user variable.
-
enumerator
UVW_EDIT
Uses a text input to edit the user variable.
-
enumerator
UVW_VIEW
The user variable can only be viewed. It can’t be modified.
-
enumerator
-
enum
RFK::
KEYBOARD_KEY
Describes the special keyboard keys.
Values:
-
enumerator
KEY_ESCAPE
-
enumerator
KEY_TAB
-
enumerator
KEY_RETURN
-
enumerator
KEY_SPACE
-
enumerator
KEY_SHIFT
-
enumerator
KEY_LEFT
-
enumerator
KEY_UP
-
enumerator
KEY_RIGHT
-
enumerator
KEY_DOWN
-
enumerator
KEY_LSHIFT
-
enumerator
KEY_LCTRL
-
enumerator
KEY_MINUS
-
enumerator
KEY_PLUS
-
enumerator
-
enum
RFK::
LOOP_MODE
Lists the possible modes used for the rendering of an image once we’ve step into the RFK::TutorialApplication::MainLoop method. The loop mode can be chosen using RFK::TutorialApplication::SetLoopMode.
Values:
-
enumerator
LM_ACTIVE
Frames are continuously rendered. The application does not wait for new events to render another frame. The OnUpdate callback is called every frame before the rendering.
-
enumerator
LM_PASSIVE
A frame is only rendered when a camera movement or when an user interaction with the scene has occured. The application waits for user input events to be emitted before rendering.
-
enumerator
LM_SOFTWARE_BY_SURFACE
A frame is rendered using the software ray-tracer for the main camera of the window. At least a ray-tracer option must be set for this loop to be effective. The application must have been initialized with the hybrid flag set to true.
-
enumerator
LM_SOFTWARE_BY_BLOCKS
A loop similar to RFK::LM_SOFTWARE_BY_SURFACE, but for which RED::IWindow::FrameTracing is configured to render the frame by blocks. This is used for scenes that have a big calculation time per pixel, to preserve the feedback.
-
enumerator
LM_SOFTWARE_PATH_TRACING
A loop similar to RFK::LM_SOFTWARE_BY_SURFACE, but for which RED::IWindow::FrameTracing is configured to render the frame using path-tracing.
-
enumerator
LM_CUSTOM
Using this loop mode, the window drawing and transaction management is entirely turned off and let under the application control.
-
enumerator
LM_CONSOLE
Using this loop mode, the application runs in console mode. No GUI is displayed and therefore, no windows manager is required.
-
enumerator
Type Alias Documentation
-
typedef RED_RC (*
RFK::
EVENT_CALLBACK
)(EventInfo &iEventInfo, void *iParam) User event callback.
If the call succeeds, the callback must return RED_OK.
-
typedef RED_RC (*
RFK::
COMMAND_CALLBACK
)(int iCommand) User command callback.
If the call succeeds, the callback must return RED_OK.