Browse Source

Update docs/src/c-api.md

Co-authored-by: Philipp Oppermann <dev@phil-opp.com>
tags/v0.2.0-rc
Haixuan Xavier Tao GitHub 2 years ago
parent
commit
f8538dcf09
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
  1. +1
    -1
      docs/src/c-api.md

+ 1
- 1
docs/src/c-api.md View File

@@ -37,7 +37,7 @@ void *dora_context = init_dora_context_from_env();

#### `dora_next_event`

`dora_next_event` waits for the next input. To extract the input ID and data, use `read_dora_input_id` and `read_dora_input_data` on the returned pointer.
`dora_next_event` waits for the next event (e.g. an input). Use `read_dora_event_type` to read the event's type. Inputs are of type `DoraEventType_Input`. To extract the ID and data of an input event, use `read_dora_input_id` and `read_dora_input_data` on the returned pointer. It is safe to ignore any events and handle only the events that are relevant to the node.

```c
void *input = dora_next_input(dora_context);


Loading…
Cancel
Save