FreeRDP
|
Data Structures | |
struct | UwacPosition |
a position More... | |
struct | UwacSize |
a rectangle size measure More... | |
struct | UwacOutputNewEvent |
struct | UwacSeatNewEvent |
struct | UwacSeatRemovedEvent |
struct | UwacKeyboardEnterLeaveEvent |
struct | UwacKeyboardModifiersEvent |
struct | UwacPointerEnterLeaveEvent |
struct | UwacPointerMotionEvent |
struct | UwacPointerButtonEvent |
struct | UwacPointerAxisEvent |
struct | UwacPointerFrameEvent |
struct | UwacPointerSourceEvent |
struct | UwacTouchCancel |
struct | UwacTouchMotion |
struct | UwacFrameDoneEvent |
struct | UwacConfigureEvent |
struct | UwacKeyEvent |
struct | UwacCloseEvent |
struct | UwacClipboardEvent |
struct | UwacOutputGeometryEvent |
union | UwacEvent |
Macros | |
#define | UWAC_API |
Typedefs | |
typedef uint32_t | UwacSeatId |
typedef bool(* | UwacErrorHandler) (UwacDisplay *d, UwacReturnCode code, const char *msg,...) |
typedef void(* | UwacDataTransferHandler) (UwacSeat *seat, void *context, const char *mime, int fd) |
typedef void(* | UwacCancelDataTransferHandler) (UwacSeat *seat, void *context) |
Functions | |
UWAC_API void | UwacInstallErrorHandler (UwacErrorHandler handler) |
UWAC_API UwacDisplay * | UwacOpenDisplay (const char *name, UwacReturnCode *err) |
UWAC_API UwacReturnCode | UwacCloseDisplay (UwacDisplay **pdisplay) |
UWAC_API int | UwacDisplayGetFd (UwacDisplay *display) |
UWAC_API const char * | UwacErrorString (UwacReturnCode error) |
UWAC_API UwacReturnCode | UwacDisplayGetLastError (const UwacDisplay *display) |
UWAC_API UwacReturnCode | UwacDisplayQueryInterfaceVersion (const UwacDisplay *display, const char *name, uint32_t *version) |
UWAC_API uint32_t | UwacDisplayQueryGetNbShmFormats (UwacDisplay *display) |
UWAC_API UwacReturnCode | UwacDisplayQueryShmFormats (const UwacDisplay *display, enum wl_shm_format *formats, int formats_size, int *filled) |
UWAC_API uint32_t | UwacDisplayGetNbOutputs (const UwacDisplay *display) |
UWAC_API const UwacOutput * | UwacDisplayGetOutput (UwacDisplay *display, int index) |
UWAC_API UwacReturnCode | UwacOutputGetResolution (const UwacOutput *output, UwacSize *resolution) |
UWAC_API UwacReturnCode | UwacOutputGetPosition (const UwacOutput *output, UwacPosition *pos) |
UWAC_API UwacWindow * | UwacCreateWindowShm (UwacDisplay *display, uint32_t width, uint32_t height, enum wl_shm_format format) |
UWAC_API UwacReturnCode | UwacDestroyWindow (UwacWindow **window) |
UWAC_API UwacReturnCode | UwacWindowSetOpaqueRegion (UwacWindow *window, uint32_t x, uint32_t y, uint32_t width, uint32_t height) |
UWAC_API UwacReturnCode | UwacWindowSetInputRegion (UwacWindow *window, uint32_t x, uint32_t y, uint32_t width, uint32_t height) |
UWAC_API void * | UwacWindowGetDrawingBuffer (UwacWindow *window) |
UWAC_API UwacReturnCode | UwacWindowAddDamage (UwacWindow *window, uint32_t x, uint32_t y, uint32_t width, uint32_t height) |
UWAC_API UwacReturnCode | UwacWindowGetDrawingBufferGeometry (UwacWindow *window, UwacSize *geometry, size_t *stride) |
UWAC_API UwacReturnCode | UwacWindowSubmitBuffer (UwacWindow *window, bool copyContentForNextFrame) |
UWAC_API UwacReturnCode | UwacWindowGetGeometry (UwacWindow *window, UwacSize *geometry) |
UWAC_API UwacReturnCode | UwacWindowSetFullscreenState (UwacWindow *window, UwacOutput *output, bool isFullscreen) |
UWAC_API void | UwacWindowSetTitle (UwacWindow *window, const char *name) |
UWAC_API void | UwacWindowSetAppId (UwacWindow *window, const char *app_id) |
UWAC_API int | UwacDisplayDispatch (UwacDisplay *display, int timeout) |
UWAC_API bool | UwacHasEvent (UwacDisplay *display) |
UWAC_API UwacReturnCode | UwacNextEvent (UwacDisplay *display, UwacEvent *event) |
UWAC_API const char * | UwacSeatGetName (const UwacSeat *seat) |
UWAC_API UwacSeatId | UwacSeatGetId (const UwacSeat *seat) |
UWAC_API UwacReturnCode | UwacClipboardOfferDestroy (UwacSeat *seat) |
UWAC_API UwacReturnCode | UwacClipboardOfferCreate (UwacSeat *seat, const char *mime) |
UWAC_API UwacReturnCode | UwacClipboardOfferAnnounce (UwacSeat *seat, void *context, UwacDataTransferHandler transfer, UwacCancelDataTransferHandler cancel) |
UWAC_API void * | UwacClipboardDataGet (UwacSeat *seat, const char *mime, size_t *size) |
UWAC_API UwacReturnCode | UwacSeatInhibitShortcuts (UwacSeat *seat, bool inhibit) |
UWAC_API UwacReturnCode | UwacSeatSetMouseCursor (UwacSeat *seat, const void *data, size_t length, size_t width, size_t height, size_t hot_x, size_t hot_y) |
UwacSeatSetMouseCursor Sets the specified image as the new mouse cursor. Special values: If data == NULL && lenght == 0 the cursor is hidden, if data == NULL && length != 0 the default system cursor is used. More... | |
#define UWAC_API |
typedef void(* UwacCancelDataTransferHandler) (UwacSeat *seat, void *context) |
typedef void(* UwacDataTransferHandler) (UwacSeat *seat, void *context, const char *mime, int fd) |
typedef bool(* UwacErrorHandler) (UwacDisplay *d, UwacReturnCode code, const char *msg,...) |
typedef uint32_t UwacSeatId |
anonymous enum |
anonymous enum |
event types
anonymous enum |
enum UwacReturnCode |
UWAC_API void* UwacClipboardDataGet | ( | UwacSeat * | seat, |
const char * | mime, | ||
size_t * | size | ||
) |
UWAC_API UwacReturnCode UwacClipboardOfferAnnounce | ( | UwacSeat * | seat, |
void * | context, | ||
UwacDataTransferHandler | transfer, | ||
UwacCancelDataTransferHandler | cancel | ||
) |
UWAC_API UwacReturnCode UwacClipboardOfferCreate | ( | UwacSeat * | seat, |
const char * | mime | ||
) |
UWAC_API UwacReturnCode UwacClipboardOfferDestroy | ( | UwacSeat * | seat | ) |
UWAC_API UwacReturnCode UwacCloseDisplay | ( | UwacDisplay ** | pdisplay | ) |
closes the corresponding UwacDisplay
pdisplay | a pointer on the display to close |
UWAC_API UwacWindow* UwacCreateWindowShm | ( | UwacDisplay * | display, |
uint32_t | width, | ||
uint32_t | height, | ||
enum wl_shm_format | format | ||
) |
creates a window using a SHM surface
display | the display to attach the window to |
width | the width of the window |
height | the heigh of the window |
format | format to use for the SHM surface |
UWAC_API UwacReturnCode UwacDestroyWindow | ( | UwacWindow ** | window | ) |
destroys the corresponding UwacWindow
window | a pointer on the UwacWindow to destroy |
UWAC_API int UwacDisplayDispatch | ( | UwacDisplay * | display, |
int | timeout | ||
) |
Dispatch the display
display | The display to dispatch |
timeout | The maximum time to wait in milliseconds (-1 == infinite). |
UWAC_API int UwacDisplayGetFd | ( | UwacDisplay * | display | ) |
Returns the file descriptor associated with the UwacDisplay, this is useful when you want to poll that file descriptor for activity.
display | an opened UwacDisplay |
UWAC_API UwacReturnCode UwacDisplayGetLastError | ( | const UwacDisplay * | display | ) |
returns the last error that occurred on a display
display | the display |
UWAC_API uint32_t UwacDisplayGetNbOutputs | ( | const UwacDisplay * | display | ) |
returns the number of registered outputs
display | the display to query |
UWAC_API const UwacOutput* UwacDisplayGetOutput | ( | UwacDisplay * | display, |
int | index | ||
) |
retrieve a particular UwacOutput object
display | the display to query |
index | index of the output |
UWAC_API uint32_t UwacDisplayQueryGetNbShmFormats | ( | UwacDisplay * | display | ) |
returns the number SHM formats that have been reported by the compositor
display | a connected UwacDisplay |
UWAC_API UwacReturnCode UwacDisplayQueryInterfaceVersion | ( | const UwacDisplay * | display, |
const char * | name, | ||
uint32_t * | version | ||
) |
retrieves the version of a given interface
display | the display connection |
name | the name of the interface |
version | the output variable for the version |
UWAC_API UwacReturnCode UwacDisplayQueryShmFormats | ( | const UwacDisplay * | display, |
enum wl_shm_format * | formats, | ||
int | formats_size, | ||
int * | filled | ||
) |
returns the supported ShmFormats
display | a connected UwacDisplay |
formats | a pointer on an array of wl_shm_format with enough place for formats_size items |
formats_size | the size of the formats array |
filled | the number of filled entries in the formats array |
UWAC_API const char* UwacErrorString | ( | UwacReturnCode | error | ) |
Returns a human readable form of a Uwac error code
error | the error number |
Returns if you have some pending events, and you can UwacNextEvent() without blocking
display | the UwacDisplay |
UWAC_API void UwacInstallErrorHandler | ( | UwacErrorHandler | handler | ) |
install a handler that will be called when UWAC encounter internal errors. The handler is supposed to answer if the execution can continue. I can also be used to log things.
handler | the error handling function to install |
UWAC_API UwacReturnCode UwacNextEvent | ( | UwacDisplay * | display, |
UwacEvent * | event | ||
) |
Waits until an event occurs, and when it's there copy the event from the queue to event.
display | the Uwac display |
event | the event to fill |
UWAC_API UwacDisplay* UwacOpenDisplay | ( | const char * | name, |
UwacReturnCode * | err | ||
) |
Opens the corresponding wayland display, using NULL you will open the default display.
name | the name of the display to open |
UWAC_API UwacReturnCode UwacOutputGetPosition | ( | const UwacOutput * | output, |
UwacPosition * | pos | ||
) |
retrieve the position of a given UwacOutput
output | the UwacOutput |
pos | a pointer on the target position |
UWAC_API UwacReturnCode UwacOutputGetResolution | ( | const UwacOutput * | output, |
UwacSize * | resolution | ||
) |
retrieve the resolution of a given UwacOutput
output | the UwacOutput |
resolution | a pointer on the |
UWAC_API UwacSeatId UwacSeatGetId | ( | const UwacSeat * | seat | ) |
returns the id of the given UwacSeat
seat | the UwacSeat |
UWAC_API const char* UwacSeatGetName | ( | const UwacSeat * | seat | ) |
returns the name of the given UwacSeat
seat | the UwacSeat |
UWAC_API UwacReturnCode UwacSeatInhibitShortcuts | ( | UwacSeat * | seat, |
bool | inhibit | ||
) |
Inhibits or restores keyboard shortcuts.
seat | The UwacSeat to inhibit the shortcuts for |
inhibit | Inhibit or restore keyboard shortcuts |
UWAC_API UwacReturnCode UwacSeatSetMouseCursor | ( | UwacSeat * | seat, |
const void * | data, | ||
size_t | length, | ||
size_t | width, | ||
size_t | height, | ||
size_t | hot_x, | ||
size_t | hot_y | ||
) |
UwacSeatSetMouseCursor Sets the specified image as the new mouse cursor. Special values: If data == NULL && lenght == 0 the cursor is hidden, if data == NULL && length != 0 the default system cursor is used.
seat | The UwacSeat to apply the cursor image to |
data | A pointer to the image data |
length | The size of the image data |
width | The image width in pixel |
height | The image height in pixel |
hot_x | The hotspot horizontal offset in pixel |
hot_y | The hotspot vertical offset in pixel |
UWAC_API UwacReturnCode UwacWindowAddDamage | ( | UwacWindow * | window, |
uint32_t | x, | ||
uint32_t | y, | ||
uint32_t | width, | ||
uint32_t | height | ||
) |
sets a rectangle as dirty for the next frame of a window
window | the UwacWindow |
x | left coordinate |
y | top coordinate |
width | the width of the dirty rectangle |
height | the height of the dirty rectangle |
UWAC_API void* UwacWindowGetDrawingBuffer | ( | UwacWindow * | window | ) |
retrieves a pointer on the current window content to draw a frame
window | the UwacWindow |
UWAC_API UwacReturnCode UwacWindowGetDrawingBufferGeometry | ( | UwacWindow * | window, |
UwacSize * | geometry, | ||
size_t * | stride | ||
) |
returns the geometry of the given UwacWindow buffer
window | the UwacWindow |
geometry | the geometry to fill |
stride | the length of a buffer line in bytes |
UWAC_API UwacReturnCode UwacWindowGetGeometry | ( | UwacWindow * | window, |
UwacSize * | geometry | ||
) |
returns the geometry of the given UwacWindows
window | the UwacWindow |
geometry | the geometry to fill |
UWAC_API void UwacWindowSetAppId | ( | UwacWindow * | window, |
const char * | app_id | ||
) |
Sets the app id of the UwacWindow
window | the UwacWindow |
app_id | app id |
UWAC_API UwacReturnCode UwacWindowSetFullscreenState | ( | UwacWindow * | window, |
UwacOutput * | output, | ||
bool | isFullscreen | ||
) |
Sets or unset the fact that the window is set fullscreen. After this call the application should get prepared to receive a configure event. The output is used only when going fullscreen, it is optional and not used when exiting fullscreen.
window | the UwacWindow |
output | an optional UwacOutput to put the window fullscreen on |
isFullscreen | set or unset fullscreen |
UWAC_API UwacReturnCode UwacWindowSetInputRegion | ( | UwacWindow * | window, |
uint32_t | x, | ||
uint32_t | y, | ||
uint32_t | width, | ||
uint32_t | height | ||
) |
Sets the region of the window that can trigger input events
window | the UwacWindow |
x | The horizontal coordinate in pixels |
y | The vertical coordinate in pixels |
width | The width of the region |
height | The height of the region |
UWAC_API UwacReturnCode UwacWindowSetOpaqueRegion | ( | UwacWindow * | window, |
uint32_t | x, | ||
uint32_t | y, | ||
uint32_t | width, | ||
uint32_t | height | ||
) |
Sets the region that should be considered opaque to the compositor.
window | the UwacWindow |
x | The horizontal coordinate in pixels |
y | The vertical coordinate in pixels |
width | The width of the region |
height | The height of the region |
UWAC_API void UwacWindowSetTitle | ( | UwacWindow * | window, |
const char * | name | ||
) |
When possible (depending on the shell) sets the title of the UwacWindow
window | the UwacWindow |
name | title |
UWAC_API UwacReturnCode UwacWindowSubmitBuffer | ( | UwacWindow * | window, |
bool | copyContentForNextFrame | ||
) |
Sends a frame to the compositor with the content of the drawing buffer
window | the UwacWindow to refresh |
copyContentForNextFrame | if true the content to display is copied in the next drawing buffer |