keyframe_base_api_t Struct Reference

Base API for all keyframe types. More...

#include <keyframes.h>

Data Fields
bool(*	render_frame )(keyframe_base_t *const p_keyframe, timestep_t time, color_rgb_t *p_color_out)
	Renders a keyframe for the given time step. More...
void(*	render_init )(keyframe_base_t *const p_keyframe, framerate_t framerate, color_rgb_t current_color)
	Initialize the renderer for the keyframe. More...
keyframe_base_t *(*	clone )(keyframe_base_t const *const p_keyframe)
	Create a copy of the keyframe. More...

Detailed Description

Base API for all keyframe types.

Field Documentation

clone

keyframe_base_t *(* keyframe_base_api_t::clone) (keyframe_base_t const *const p_keyframe)

Create a copy of the keyframe.

Parameters

[in]

p_keyframe

Pointer to the keyframe to copy.

Returns

Pointer to the cloned keyframe or NULL on failure.

render_frame

bool(* keyframe_base_api_t::render_frame) (keyframe_base_t *const p_keyframe, timestep_t time, color_rgb_t *p_color_out)

Renders a keyframe for the given time step.

Parameters

[in]	p_keyframe	Pointer to the keyframe.
	time	Current time step for animation.
[out]	p_color_out	Pointer to the rendered RGB color for this time step.

Returns

true if the keyframe has completed, false if more frames remain.

render_init

void(* keyframe_base_api_t::render_init) (keyframe_base_t *const p_keyframe, framerate_t framerate, color_rgb_t current_color)

Initialize the renderer for the keyframe.

Parameters

[in]	p_keyframe	Pointer to the keyframe.
	framerate	Framerate for keyframe rendering.
	current_color	The current color being used.

---

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

• /github/workspace/src/src/pixelkey/keyframes/keyframes.h