lv_gltf.h

lv_gltf_set_environment

Assign an environment to a glTF object for IBL rendering

void lv_gltf_set_environment(lv_obj_t *obj, lv_gltf_environment_t *environment)

lv_gltf_set_yaw

Set the yaw (horizontal rotation) of the camera

void lv_gltf_set_yaw(lv_obj_t *obj, float yaw)

lv_gltf_set_pitch

Set the pitch (vertical rotation) of the camera

void lv_gltf_set_pitch(lv_obj_t *obj, float pitch)

lv_gltf_set_distance

Set the camera distance from the focal point

void lv_gltf_set_distance(lv_obj_t *obj, float value)

lv_gltf_set_fov

Set the field of view

void lv_gltf_set_fov(lv_obj_t *obj, float value)

lv_gltf_set_focal_x

Set the X coordinate of the camera focal point

void lv_gltf_set_focal_x(lv_obj_t *obj, float value)

lv_gltf_set_focal_y

Set the Y coordinate of the camera focal point

void lv_gltf_set_focal_y(lv_obj_t *obj, float value)

lv_gltf_set_focal_z

Set the Z coordinate of the camera focal point

void lv_gltf_set_focal_z(lv_obj_t *obj, float value)

lv_gltf_set_camera

Set the active camera index The camera is selected from the first glTF model added to the viewer

void lv_gltf_set_camera(lv_obj_t *obj, uint32_t value)

lv_gltf_set_animation_speed

DEPRECATED. See lv_gltf_model_set_animation_speed

Set the animation speed ratio

The actual ratio is the value parameter / LV_GLTF_ANIM_SPEED_NORMAL Values greater than LV_GLTF_ANIM_SPEED_NORMAL will speed-up the animation Values less than LV_GLTF_ANIM_SPEED_NORMAL will slow down the animation

void lv_gltf_set_animation_speed(lv_obj_t *obj, uint32_t value)

lv_gltf_set_background_mode

Set the background mode

void lv_gltf_set_background_mode(lv_obj_t *obj, lv_gltf_bg_mode_t value)

lv_gltf_set_background_blur

Set the background blur amount

void lv_gltf_set_background_blur(lv_obj_t *obj, uint32_t value)

lv_gltf_set_environment_brightness

Set the environment brightness of a glTF viewer.

void lv_gltf_set_environment_brightness(lv_obj_t *obj, float value)

lv_gltf_set_env_brightness

Set the environment brightness.

> Deprecated: Use lv_gltf_set_environment_brightness() instead, which takes a multiplier (1.0 = neutral).

void lv_gltf_set_env_brightness(lv_obj_t *obj, uint32_t value)

lv_gltf_set_image_exposure

Set the image exposure level

void lv_gltf_set_image_exposure(lv_obj_t *obj, float value)

lv_gltf_set_antialiasing_mode

Set the anti-aliasing mode

void lv_gltf_set_antialiasing_mode(lv_obj_t *obj, lv_gltf_aa_mode_t value)

lv_gltf_get_model_count

Get the number of models loaded in the glTF viewer

size_t lv_gltf_get_model_count(lv_obj_t *obj)

Returns: size_t — the total number of models in the viewer

lv_gltf_get_model_by_index

Get a specific model by its index

lv_gltf_model_t * lv_gltf_get_model_by_index(const lv_obj_t *obj, size_t id)

Returns: lv_gltf_model_t * — pointer to the model at the specified index, or NULL if index is invalid

lv_gltf_get_primary_model

Get the primary model from the glTF viewer The primary model is the first model added to the viewer and can be used for camera selection and other primary operations

lv_gltf_model_t * lv_gltf_get_primary_model(const lv_obj_t *obj)

Returns: lv_gltf_model_t * — pointer to the primary model, or NULL if no models are loaded

lv_gltf_get_yaw

Get the yaw (horizontal rotation) of the camera

float lv_gltf_get_yaw(const lv_obj_t *obj)

Returns: float — yaw angle in degrees

lv_gltf_get_pitch

Get the pitch (vertical rotation) of the camera

float lv_gltf_get_pitch(const lv_obj_t *obj)

Returns: float — pitch angle in degrees

lv_gltf_get_distance

Get the camera distance scale factor from the focal point

float lv_gltf_get_distance(const lv_obj_t *obj)

Returns: float — distance scaling factor value

lv_gltf_get_world_distance

Get the camera distance from the focal point in world units

float lv_gltf_get_world_distance(const lv_obj_t *obj)

Returns: float — world unit distance value

lv_gltf_get_fov

Get the field of view

float lv_gltf_get_fov(const lv_obj_t *obj)

Returns: float — vertical FOV in degrees

lv_gltf_get_focal_x

Get the X coordinate of the camera focal point

float lv_gltf_get_focal_x(const lv_obj_t *obj)

Returns: float — X coordinate

lv_gltf_get_focal_y

Get the Y coordinate of the camera focal point

float lv_gltf_get_focal_y(const lv_obj_t *obj)

Returns: float — Y coordinate

lv_gltf_get_focal_z

Get the Z coordinate of the camera focal point

float lv_gltf_get_focal_z(const lv_obj_t *obj)

Returns: float — Z coordinate

lv_gltf_get_camera

Get the active camera index

uint32_t lv_gltf_get_camera(const lv_obj_t *obj)

Returns: uint32_t — active camera index

lv_gltf_get_camera_count

Get the number of cameras in the first glTF model added to the viewer This count represents the valid range for the camera index parameter used with lv_gltf_set_camera()

To get the camera count of other models, call lv_gltf_model_get_camera_count(model) directly with the specific model

uint32_t lv_gltf_get_camera_count(const lv_obj_t *obj)

Returns: uint32_t — number of available cameras

lv_gltf_get_animation_speed

DEPRECATED. See lv_gltf_model_get_animation_speed

Get the animation speed ratio

The actual ratio is the return value / LV_GLTF_ANIM_SPEED_NORMAL

uint32_t lv_gltf_get_animation_speed(const lv_obj_t *obj)

lv_gltf_get_background_mode

Get the background mode

lv_gltf_bg_mode_t lv_gltf_get_background_mode(const lv_obj_t *obj)

Returns: lv_gltf_bg_mode_t — background mode

lv_gltf_get_background_blur

Get the background blur amount

uint32_t lv_gltf_get_background_blur(const lv_obj_t *obj)

Returns: uint32_t — blur amount between 0 and 100

lv_gltf_get_environment_brightness

Get the environment brightness of a glTF viewer.

float lv_gltf_get_environment_brightness(const lv_obj_t *obj)

Returns: float — brightness multiplier, 1.0 = neutral

lv_gltf_get_env_brightness

Get the environment brightness.

> Deprecated: Use lv_gltf_get_environment_brightness() instead, which returns a multiplier (1.0 = neutral).

uint32_t lv_gltf_get_env_brightness(const lv_obj_t *obj)

Returns: uint32_t — brightness percentage, 100 = neutral

lv_gltf_get_image_exposure

Get the image exposure level

float lv_gltf_get_image_exposure(const lv_obj_t *obj)

Returns: float — exposure level

lv_gltf_get_antialiasing_mode

Get the anti-aliasing mode

lv_gltf_aa_mode_t lv_gltf_get_antialiasing_mode(const lv_obj_t *obj)

Returns: lv_gltf_aa_mode_t — anti-aliasing mode

lv_gltf_get_current_view_plane

Get a plane that faces the current view camera, centered some units in front of it

lv_3dplane_t lv_gltf_get_current_view_plane(lv_obj_t *obj, float distance)

Returns: lv_3dplane_t — camera facing plane

lv_gltf_get_ray_from_2d_coordinate

Calculates a ray originating from the camera and passing through the specified mouse position on the screen.

lv_3dray_t lv_gltf_get_ray_from_2d_coordinate(lv_obj_t *obj, const lv_point_t *screen_pos)

Returns: lv_3dray_t — mouse point ray

lv_gltf_create

Create a glTF object

lv_obj_t * lv_gltf_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created glTF object

lv_gltf_load_model_from_file

Load a glTF model from a file into the viewer

lv_gltf_model_t * lv_gltf_load_model_from_file(lv_obj_t *obj, const char *path)

Returns: lv_gltf_model_t * — pointer to the loaded glTF model, or NULL on failure

lv_gltf_load_model_from_bytes

Load a glTF model from a byte array into the viewer

lv_gltf_model_t * lv_gltf_load_model_from_bytes(lv_obj_t *obj, const uint8_t *bytes, size_t len)

Returns: lv_gltf_model_t * — pointer to the loaded glTF model, or NULL on failure

lv_gltf_add_model

Add a glTF model to the viewer.

Contrary to lv_gltf_load_model_from_file and lv_gltf_load_model_from_bytes, the model is owned by the caller of this function meaning that it's the caller's responsibility to delete the model when it is no longer needed, with lv_gltf_model_delete. Deleting it while the viewer still shows it is allowed, the viewer lets go of it.

lv_result_t lv_gltf_add_model(lv_obj_t *obj, lv_gltf_model_t *model)

Returns: lv_result_t — LV_RESULT_OK if the model was added to the viewer or LV_RESULT_INVALID on failure

lv_gltf_remove_model

Remove a model from the glTF viewer

void lv_gltf_remove_model(lv_obj_t *obj, lv_gltf_model_t *model)

lv_gltf_remove_all_models

Remove all models from the glTF viewer

void lv_gltf_remove_all_models(lv_obj_t *obj)

lv_gltf_recenter

Set the focal coordinates to the center point of the model object

void lv_gltf_recenter(lv_obj_t *obj, lv_gltf_model_t *model)

lv_intersect_ray_with_plane

Get the point that a given ray intersects with a specified plane at, if any

lv_result_t lv_intersect_ray_with_plane(const lv_3dray_t *ray, const lv_3dplane_t *plane, lv_3dpoint_t *collision_point)

Returns: lv_result_t — LV_RESULT_OK if intersection, LV_RESULT_INVALID if no intersection

lv_gltf_world_to_screen

Get the screen position of a 3d point

lv_result_t lv_gltf_world_to_screen(lv_obj_t *obj, const lv_3dpoint_t world_pos, lv_point_t *screen_pos)

Returns: lv_result_t — LV_RESULT_OK if conversion valid, LV_RESULT_INVALID if no valid conversion