Open Broadcaster Software
Free, open source software for live streaming and recording
obs_modeless_ui Struct Reference

Data Fields

const char * id
 
const char * task
 
const char * target
 
void *(* create )(void *object, void *ui_data)
 
void * type_data
 
void(* free_type_data )(void *type_data)
 

Detailed Description

Modeless UI definition structure

Field Documentation

§ create

void*(* obs_modeless_ui::create) (void *object, void *ui_data)

Callback to create modeless interface.

This function is almost identical to the modal exec function, except modeless UI calls return immediately, and typically are supposed to return a pointer or handle to the specific UI object that was created. For example, a Qt object would ideally return a pointer to a QWidget. Again, discretion and consistency is advised for the return value.

Parameters
objectPointer/handle to the data associated with this call.
ui_dataUI data to pass associated with this specific target, if any.
Returns
Pointer/handle to the modeless UI associated with the specific target.

§ free_type_data

void(* obs_modeless_ui::free_type_data) (void *type_data)

§ id

const char* obs_modeless_ui::id

Identifier associated with this UI

§ target

const char* obs_modeless_ui::target

UI target (UI toolkit or program name)

§ task

const char* obs_modeless_ui::task

Task of the UI

§ type_data

void* obs_modeless_ui::type_data

The documentation for this struct was generated from the following file: