curve.h

#include <modkit/curve.h>10 functions · 8 structs · 4 enums · 12 typedefs · 2 macros

Immutable baked scalar curves and color gradients.

Functions

mk_color_distribution_samplefunction

mk_vec4 mk_color_distribution_sample(const mk_color_distribution *distribution, float time, float random01)

Sample an authored RGBA distribution with random01 clamped to [0,1].

Parameter	Type	Description
distribution	const mk_color_distribution *	Value for distribution.
time	float	Value for time.
random01	float	Value for random01.

Returns The resulting value.

mk_curve_createfunction

mk_curve_t mk_curve_create(const mk_curve_desc *desc)

Create curve.

Parameter	Type	Description
desc	const mk_curve_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_curve_destroyfunction

void mk_curve_destroy(mk_curve_t curve)

Destroy the curve.

Parameter	Type	Description
curve	mk_curve_t	Value for curve.

mk_curve_samplefunction

float mk_curve_sample(mk_curve_t curve, float time)

Perform the curve sample operation.

Parameter	Type	Description
curve	mk_curve_t	Value for curve.
time	float	Value for time.

Returns The resulting value.

mk_curve_validfunction

bool mk_curve_valid(mk_curve_t curve)

Perform the curve valid operation.

Parameter	Type	Description
curve	mk_curve_t	Value for curve.

Returns True when the operation succeeds.

mk_gradient_createfunction

mk_gradient_t mk_gradient_create(const mk_gradient_desc *desc)

Create gradient.

Parameter	Type	Description
desc	const mk_gradient_desc *	Configuration descriptor.

Returns The resulting handle or value.

mk_gradient_destroyfunction

void mk_gradient_destroy(mk_gradient_t gradient)

Destroy the gradient.

Parameter	Type	Description
gradient	mk_gradient_t	Value for gradient.

mk_gradient_samplefunction

mk_vec4 mk_gradient_sample(mk_gradient_t gradient, float time)

Perform the gradient sample operation.

Parameter	Type	Description
gradient	mk_gradient_t	Value for gradient.
time	float	Value for time.

Returns The resulting value.

mk_gradient_validfunction

bool mk_gradient_valid(mk_gradient_t gradient)

Perform the gradient valid operation.

Parameter	Type	Description
gradient	mk_gradient_t	Value for gradient.

Returns True when the operation succeeds.

mk_scalar_distribution_samplefunction

float mk_scalar_distribution_sample(const mk_scalar_distribution *distribution, float time, float random01)

Perform the scalar distribution sample operation.

Parameter	Type	Description
distribution	const mk_scalar_distribution *	Value for distribution.
time	float	Value for time.
random01	float	Value for random01.

Returns The resulting value.

Structs

mk_color_distributionstruct

Data for color distribution.

Field	Type	Description
type	mk_color_distribution_type	The type.
min_color	mk_vec4	The min color.
max_color	mk_vec4	The max color.
min_gradient	mk_gradient_t	The min gradient.
max_gradient	mk_gradient_t	The max gradient.

mk_curvestruct

Data for curve.

Field	Type	Description
id	uint32_t	The ID.

mk_curve_descstruct

Data for curve desc.

Field	Type	Description
keys	const mk_curve_key *	The keys.
key_count	uint32_t	The key count.
bake_samples	uint32_t	0 selects 256.
wrap	mk_curve_wrap	The wrap.

mk_curve_keystruct

Data for curve key.

Field	Type	Description
time	float	The time.
value	float	The value.
in_tangent	float	The in tangent.
out_tangent	float	The out tangent.
interpolation	mk_curve_interpolation	The interpolation.

mk_gradientstruct

Data for gradient.

Field	Type	Description
id	uint32_t	The ID.

mk_gradient_descstruct

Data for gradient desc.

Field	Type	Description
keys	const mk_gradient_key *	The keys.
key_count	uint32_t	The key count.
bake_samples	uint32_t	0 selects 256.
wrap	mk_curve_wrap	The wrap.

mk_gradient_keystruct

Data for gradient key.

Field	Type	Description
time	float	The time.
color	mk_vec4	The color.
interpolation	mk_curve_interpolation	The interpolation.

mk_scalar_distributionstruct

Data for scalar distribution.

Field	Type	Description
type	mk_scalar_distribution_type	The type.
min_value	float	The min value.
max_value	float	The max value.
min_curve	mk_curve_t	The min curve.
max_curve	mk_curve_t	The max curve.

Enums

mk_color_distribution_typeenum

Values for color distribution type.

Value	Description
MK_COLOR_DISTRIBUTION_CONSTANT	Selects constant.
MK_COLOR_DISTRIBUTION_RANGE	Selects range.
MK_COLOR_DISTRIBUTION_GRADIENT	Selects gradient.
MK_COLOR_DISTRIBUTION_TWO_GRADIENTS	Selects two gradients.

mk_curve_interpolationenum

Values for curve interpolation.

Value	Description
MK_CURVE_LINEAR	Selects linear.
MK_CURVE_STEP	Selects step.
MK_CURVE_HERMITE	Selects hermite.

mk_curve_wrapenum

Values for curve wrap.

Value	Description
MK_CURVE_WRAP_CLAMP	Selects clamp.
MK_CURVE_WRAP_REPEAT	Selects repeat.
MK_CURVE_WRAP_MIRROR	Selects mirror.

mk_scalar_distribution_typeenum

A compact authored scalar distribution shared by particles and tweens.

random01 must be in [0,1]. Curve modes sample normalized time.

Value	Description
MK_SCALAR_CONSTANT	Selects constant.
MK_SCALAR_RANGE	Selects range.
MK_SCALAR_CURVE	Selects curve.
MK_SCALAR_TWO_CURVES	Selects two curves.

Typedefs

mk_color_distributiontypedef

typedef struct mk_color_distribution mk_color_distribution

Data for color distribution.

mk_color_distribution_typetypedef

typedef enum mk_color_distribution_type mk_color_distribution_type

Values for color distribution type.

mk_curve_desctypedef

typedef struct mk_curve_desc mk_curve_desc

Data for curve desc.

mk_curve_interpolationtypedef

typedef enum mk_curve_interpolation mk_curve_interpolation

Values for curve interpolation.

mk_curve_keytypedef

typedef struct mk_curve_key mk_curve_key

Data for curve key.

mk_curve_ttypedef

typedef struct mk_curve mk_curve_t

Data for curve.

mk_curve_wraptypedef

typedef enum mk_curve_wrap mk_curve_wrap

Values for curve wrap.

mk_gradient_desctypedef

typedef struct mk_gradient_desc mk_gradient_desc

Data for gradient desc.

mk_gradient_keytypedef

typedef struct mk_gradient_key mk_gradient_key

Data for gradient key.

mk_gradient_ttypedef

typedef struct mk_gradient mk_gradient_t

Data for gradient.

mk_scalar_distributiontypedef

typedef struct mk_scalar_distribution mk_scalar_distribution

Data for scalar distribution.

mk_scalar_distribution_typetypedef

typedef enum mk_scalar_distribution_type mk_scalar_distribution_type

A compact authored scalar distribution shared by particles and tweens.

random01 must be in [0,1]. Curve modes sample normalized time.

Macros

MK_CURVE_INVALIDdefine

MK_CURVE_INVALID

Invalid sentinel for curve.

MK_GRADIENT_INVALIDdefine

MK_GRADIENT_INVALID

Invalid sentinel for gradient.