dev.avyos.display
api/display/api.json
Display service API.
Service
| Field | Value |
|---|---|
| Name | dev.avyos.display |
| Package | display |
| Service ID | 0x00000010 |
| Imports | avyos.dev/pkg/graphics |
Display service API.
Types
Empty
Empty payload type.
No fields.
CreateWindowRequest
Create Window Request payload type.
| Field | Type | Description |
|---|---|---|
ShmKey |
string |
- |
Width |
int |
- |
Height |
int |
- |
Stride |
int |
- |
CreateLayerRequest
Create Layer Request payload type.
| Field | Type | Description |
|---|---|---|
Layer |
uint32 |
- |
Anchor |
uint32 |
- |
Exclusive |
int |
- |
OpaqueHint |
bool |
- |
ShmKey |
string |
- |
Width |
int |
- |
Height |
int |
- |
Stride |
int |
- |
CreatePopupRequest
Create Popup Request payload type.
| Field | Type | Description |
|---|---|---|
ParentID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
ShmKey |
string |
- |
Width |
int |
- |
Height |
int |
- |
Stride |
int |
- |
DestroyWindowRequest
Destroy Window Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
SetTitleRequest
Set Title Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Title |
string |
- |
DamageRequest
Damage Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
Width |
int |
- |
Height |
int |
- |
ResizeRequest
Resize Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
ShmKey |
string |
- |
Width |
int |
- |
Height |
int |
- |
Stride |
int |
- |
MoveRequest
Move Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
SetWindowStateRequest
Set Window State Request payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Action |
uint32 |
- |
WindowCreatedEvent
Window Created Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
ConfigureEvent
Configure Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Width |
int |
- |
Height |
int |
- |
CloseEvent
Close Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
PointerEnterEvent
Pointer Enter Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
PointerLeaveEvent
Pointer Leave Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
PointerMotionEvent
Pointer Motion Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
PointerButtonEvent
Pointer Button Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Button |
int |
- |
Pressed |
bool |
- |
KeyEvent
Key Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Key |
graphics.Key |
- |
Char |
rune |
- |
Pressed |
bool |
- |
FocusEvent
Focus Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
Focused |
bool |
- |
MovedEvent
Moved Event payload type.
| Field | Type | Description |
|---|---|---|
WindowID |
uint32 |
- |
X |
int |
- |
Y |
int |
- |
WindowListItem
Window List Item payload type.
| Field | Type | Description |
|---|---|---|
ID |
uint32 |
- |
Flags |
uint32 |
- |
Title |
string |
- |
WindowListEvent
Window List Event payload type.
| Field | Type | Description |
|---|---|---|
Windows |
[]WindowListItem |
- |
RegisterSessionRequest
Register Session Request payload type.
| Field | Type | Description |
|---|---|---|
SessionID |
uint32 |
- |
UID |
uint32 |
- |
SetActiveSessionRequest
Set Active Session Request payload type.
| Field | Type | Description |
|---|---|---|
SessionID |
uint32 |
- |
ActiveSessionEvent
Active Session Event payload type.
| Field | Type | Description |
|---|---|---|
SessionID |
uint32 |
- |
RegisterShortcutRequest
Register Shortcut Request payload type.
| Field | Type | Description |
|---|---|---|
ShortcutID |
uint32 |
- |
WindowID |
uint32 |
- |
Scope |
uint32 |
- |
Key |
graphics.Key |
- |
Rune |
rune |
- |
Modifiers |
uint8 |
- |
UnregisterShortcutRequest
Unregister Shortcut Request payload type.
| Field | Type | Description |
|---|---|---|
ShortcutID |
uint32 |
- |
ShortcutEvent
Shortcut Event payload type.
| Field | Type | Description |
|---|---|---|
ShortcutID |
uint32 |
- |
WindowID |
uint32 |
- |
Scope |
uint32 |
- |
Key |
graphics.Key |
- |
Rune |
rune |
- |
Modifiers |
uint8 |
- |
Requests
CreateWindow
0x0201
Create Window request.
Input
Type: CreateWindowRequest
Request payload type: CreateWindowRequest.
Output
Type: WindowCreatedEvent
Response payload type: WindowCreatedEvent.
DestroyWindow
0x0202
Destroy Window request.
Input
Type: DestroyWindowRequest
Request payload type: DestroyWindowRequest.
Output
Type: Empty
No response payload is returned.
SetTitle
0x0203
Set Title request.
Input
Type: SetTitleRequest
Request payload type: SetTitleRequest.
Output
Type: Empty
No response payload is returned.
Damage
0x0204
Damage request.
Input
Type: DamageRequest
Request payload type: DamageRequest.
Output
Type: Empty
No response payload is returned.
Resize
0x0205
Resize request.
Input
Type: ResizeRequest
Request payload type: ResizeRequest.
Output
Type: Empty
No response payload is returned.
Move
0x0206
Move request.
Input
Type: MoveRequest
Request payload type: MoveRequest.
Output
Type: Empty
No response payload is returned.
CreateLayer
0x0207
Create Layer request.
Input
Type: CreateLayerRequest
Request payload type: CreateLayerRequest.
Output
Type: WindowCreatedEvent
Response payload type: WindowCreatedEvent.
CreatePopup
0x0208
Create Popup request.
Input
Type: CreatePopupRequest
Request payload type: CreatePopupRequest.
Output
Type: WindowCreatedEvent
Response payload type: WindowCreatedEvent.
ListWindows
0x0209
List Windows request.
Input
Type: Empty
No input payload is required.
Output
Type: WindowListEvent
Response payload type: WindowListEvent.
SetWindowState
0x020A
Set Window State request.
Input
Type: SetWindowStateRequest
Request payload type: SetWindowStateRequest.
Output
Type: Empty
No response payload is returned.
RegisterSession
0x020B
Register Session request.
Input
Type: RegisterSessionRequest
Request payload type: RegisterSessionRequest.
Output
Type: Empty
No response payload is returned.
SetActiveSession
0x020C
Set Active Session request.
Input
Type: SetActiveSessionRequest
Request payload type: SetActiveSessionRequest.
Output
Type: Empty
No response payload is returned.
GetActiveSession
0x020D
Get Active Session request.
Input
Type: Empty
No input payload is required.
Output
Type: ActiveSessionEvent
Response payload type: ActiveSessionEvent.
RegisterShortcut
0x020E
Register Shortcut request.
Input
Type: RegisterShortcutRequest
Request payload type: RegisterShortcutRequest.
Output
Type: Empty
No response payload is returned.
UnregisterShortcut
0x020F
Unregister Shortcut request.
Input
Type: UnregisterShortcutRequest
Request payload type: UnregisterShortcutRequest.
Output
Type: Empty
No response payload is returned.
Events
WindowCreated
0x0301
Window Created event.
Payload
Type: WindowCreatedEvent
Event payload type: WindowCreatedEvent.
Configure
0x0302
Configure event.
Payload
Type: ConfigureEvent
Event payload type: ConfigureEvent.
Close
0x0303
Close event.
Payload
Type: CloseEvent
Event payload type: CloseEvent.
PointerEnter
0x0304
Pointer Enter event.
Payload
Type: PointerEnterEvent
Event payload type: PointerEnterEvent.
PointerLeave
0x0305
Pointer Leave event.
Payload
Type: PointerLeaveEvent
Event payload type: PointerLeaveEvent.
PointerMotion
0x0306
Pointer Motion event.
Payload
Type: PointerMotionEvent
Event payload type: PointerMotionEvent.
PointerButton
0x0307
Pointer Button event.
Payload
Type: PointerButtonEvent
Event payload type: PointerButtonEvent.
Key
0x0308
Key event.
Payload
Type: KeyEvent
Event payload type: KeyEvent.
Focus
0x0309
Focus event.
Payload
Type: FocusEvent
Event payload type: FocusEvent.
Moved
0x030A
Moved event.
Payload
Type: MovedEvent
Event payload type: MovedEvent.
WindowList
0x030B
Window List event.
Payload
Type: WindowListEvent
Event payload type: WindowListEvent.
SessionActivated
0x030C
Session Activated event.
Payload
Type: ActiveSessionEvent
Event payload type: ActiveSessionEvent.
SessionSuspended
0x030D
Session Suspended event.
Payload
Type: ActiveSessionEvent
Event payload type: ActiveSessionEvent.
SessionResumed
0x030E
Session Resumed event.
Payload
Type: ActiveSessionEvent
Event payload type: ActiveSessionEvent.
Shortcut
0x030F
Shortcut event.
Payload
Type: ShortcutEvent
Event payload type: ShortcutEvent.