C/C++ SDK / C ABI · Editor / KroysAutomationJob

KroysAutomationJob

Context of an automation step run by a capture script.

Kindstruct

Headerkroys/kroys_plugin.h

Members6

Functions2

DECLARATION

Declaration

Declared in kroys/kroys_plugin.h.

kroys_plugin.h

typedef struct KroysAutomationJob { ... } KroysAutomationJob;

REFERENCE

Members

Fields

#uint32_t structSize;

Size of this struct as the writer compiled it (sizeof); the reader uses it to detect members appended by later minor versions.

field

#uint32_t reserved;

Padding reserved for later use; leave it 0.

field

#const char* outputFolder;

Folder the capture writes into.

field

#void* jobContext;

Host-owned job pointer; pass it unchanged to the job's functions.

field

Functions

#void (KROYS_CALL* Hold)(void* jobContext, uint32_t frames);

Keeps the runner waiting frames frames after the step.

function pointer

#void (KROYS_CALL* Fail)(void* jobContext, const char* message);

Fails the step with a message.

function pointer

Members

uint32_t structSize;
uint32_t reserved;
const char* outputFolder;
void* jobContext;
void (KROYS_CALL* Hold)(void* jobContext, uint32_t frames);
void (KROYS_CALL* Fail)(void* jobContext, const char* message);

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.