Name 

Description 

interface 

Interface defines the functions that are exported from the render library. This interface may be retrieved with LoadInterface( "<appropriate name" ). 

keyboard 

This is namespace sack::image::render::keyboard. 

Name 

Description 

Functions 

The following table lists functions in this documentation. 

Structs, Records, Enums 

The following table lists structs, records, enums in this documentation. 

Types 

The following table lists types in this documentation. 

Macros 

The following table lists macros in this documentation. 

 

Name 

Description 

 

DisableMouseOnIdle 

Enables a timer on the mouse to hide the cursor after a second that the mouse is not being moved. 

 

EnableSpriteMethod 

Adds a sprite rendering method to the display. Just before updating to the display, the display is saved, and sprite update callbacks are issued. then the resulting display is output. Sprite data only exists on the output image just before it is put on the physical display. 

 

GetNativeHandle 

returns the native handle used to output to. this can be an SDL_Screen or HWND depending on platform. 

 

LockRenderer 

Lock the renderer for this thread to use. 

 

RequiresDrawAll 

Function to check if the draw mode of the renderer requires an ALL update (opengl/direct3d) every frame the whole display must be drawn. 

 

SetDisplayNoMouse 

Sets whether the display wants to get any mouse events at all. 

 

UnlockRenderer 

Unlock the renderer for other threads to use. 

 

WinShell_AcceptDroppedFiles 

Adds a callback to call when a file is dropped. Each callback can return 0 that it did not accept the file, or 1 that it did. once the file is accepted by a handler, it is not passed to any other handlers. 

Name 

Description 

KDF_CAPSKEY 

key is sensitive to capslock state 

KDF_NODEFINE 

set to disallow key redefinition 

KDF_NOKEY 

no keydef here... 

KDF_NOREDEF 

This is macro sack::image::render::KDF_NOREDEF. 

KDF_NUMKEY 

key is sensitive to numlock state the numpad returns num0 - ... or numpad returns home/end/pgdn etc... 

KDF_UPACTION 

action is called on key release 

KEY_STRUCTURE_DEFINED 

if !defined( DISPLAY_SOURCE ) && !defined( DISPLAY_SERVICE ) && !defined( DISPLAY_CLIENT ) 

KEYMOD_ALT 

This is macro sack::image::render::KEYMOD_ALT. 

KEYMOD_ANY 

This is macro sack::image::render::KEYMOD_ANY. 

KEYMOD_CTRL 

This is macro sack::image::render::KEYMOD_CTRL. 

KEYMOD_NORMAL 

This is macro sack::image::render::KEYMOD_NORMAL. 

KEYMOD_SHIFT 

This is macro sack::image::render::KEYMOD_SHIFT. 

OpenDisplay 

 

OpenDisplayAbove 

 

OpenDisplayAboveSized 

 

OpenDisplaySized 

 

OpenDisplayUnderSizedAt 

 

OwnMouse 

 

PRENDERER 

This is the type that the sack::image::render primarily deals with. This is used to put Image to physical display. It can be a truly alpha transparent surface on Windows XP+, and the transparent surface can do region updates in Windows Vista+.

This typename is aliased to different real structures depending on context. The application should just regard this type as a simple value and never ever try to delve into it. 

 

Name 

Description 

 

HVIDEO_tag 

Private structure for Vidlib. See PRENDERER. Exposed, but applications should use appropriate methods in render namespace. 

 

keybind_tag 

overrides to default definitions 

 

KeyDataEventType 

This is record sack::image::render::KeyDataEventType. 

 

KeyDefine 

This is record sack::image::render::KeyDefine. 

 

KEYBIND 

This is type sack::image::render::KEYBIND. 

 

PKEYBIND 

This is type sack::image::render::PKEYBIND. 

 

PVIDEO 

Private structure for Vidlib. See PRENDERER. Exposed, but applications should use appropriate methods in render namespace. 

 

VIDEO 

Private structure for Vidlib. See PRENDERER. Exposed, but applications should use appropriate methods in render namespace. 

Name 

Description 

dropped_file_acceptor 

signature for callback method to pass to WinShell_AcceptDroppedFiles.
Defines type function signature required for a user callback to handle drop file event. 

KeyTriggerHandler 

type for callback signature to handle a bound keyboard event. 

PKEYDEFINE 

This is record sack::image::render::KeyDefine.