mutter/clutter/clutter/clutter-color-state-params.h
Joan Torres 7f8df9d9a1 clutter/color-state-params: Add new_from_primitives
When creating a new color state from the primitives Colorimetry, EOTF
and Luminance; it is needed to previously check their tags to properly get
their values and avoid UB.

This check is duplicated and is a bit unreadable.

Using this new function helps keeping readability.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/4144>
2024-12-05 22:24:05 +00:00

145 lines
4.5 KiB
C

/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#include "clutter/clutter-color-state.h"
G_BEGIN_DECLS
typedef enum
{
CLUTTER_COLORSPACE_SRGB,
CLUTTER_COLORSPACE_BT2020,
CLUTTER_COLORSPACE_NTSC,
} ClutterColorspace;
typedef enum
{
CLUTTER_TRANSFER_FUNCTION_SRGB,
CLUTTER_TRANSFER_FUNCTION_PQ,
CLUTTER_TRANSFER_FUNCTION_BT709,
CLUTTER_TRANSFER_FUNCTION_LINEAR,
} ClutterTransferFunction;
typedef enum
{
CLUTTER_COLORIMETRY_TYPE_COLORSPACE,
CLUTTER_COLORIMETRY_TYPE_PRIMARIES,
} ClutterColorimetryType;
typedef enum
{
CLUTTER_EOTF_TYPE_NAMED,
CLUTTER_EOTF_TYPE_GAMMA,
} ClutterEOTFType;
typedef enum
{
CLUTTER_LUMINANCE_TYPE_DERIVED,
CLUTTER_LUMINANCE_TYPE_EXPLICIT,
} ClutterLuminanceType;
typedef struct _ClutterPrimaries
{
float r_x, r_y;
float g_x, g_y;
float b_x, b_y;
float w_x, w_y;
} ClutterPrimaries;
typedef struct _ClutterColorimetry
{
ClutterColorimetryType type : 1;
union
{
ClutterColorspace colorspace;
ClutterPrimaries *primaries;
};
} ClutterColorimetry;
typedef struct _ClutterEOTF
{
ClutterEOTFType type : 1;
union
{
ClutterTransferFunction tf_name;
float gamma_exp;
};
} ClutterEOTF;
typedef struct _ClutterLuminance
{
ClutterLuminanceType type : 1;
float min;
float max;
float ref;
} ClutterLuminance;
#define CLUTTER_TYPE_COLOR_STATE_PARAMS (clutter_color_state_params_get_type ())
CLUTTER_EXPORT
G_DECLARE_FINAL_TYPE (ClutterColorStateParams, clutter_color_state_params,
CLUTTER, COLOR_STATE_PARAMS,
ClutterColorState)
CLUTTER_EXPORT
ClutterColorState * clutter_color_state_params_new (ClutterContext *context,
ClutterColorspace colorspace,
ClutterTransferFunction transfer_function);
CLUTTER_EXPORT
ClutterColorState * clutter_color_state_params_new_full (ClutterContext *context,
ClutterColorspace colorspace,
ClutterTransferFunction transfer_function,
ClutterPrimaries *primaries,
float gamma_exp,
float min_lum,
float max_lum,
float ref_lum);
CLUTTER_EXPORT
ClutterColorState * clutter_color_state_params_new_from_primitives (ClutterContext *context,
ClutterColorimetry colorimetry,
ClutterEOTF eotf,
ClutterLuminance luminance);
CLUTTER_EXPORT
const ClutterColorimetry * clutter_color_state_params_get_colorimetry (ClutterColorStateParams *color_state_params);
CLUTTER_EXPORT
const ClutterEOTF * clutter_color_state_params_get_eotf (ClutterColorStateParams *color_state_params);
CLUTTER_EXPORT
const ClutterLuminance * clutter_color_state_params_get_luminance (ClutterColorStateParams *color_state_params);
CLUTTER_EXPORT
const ClutterLuminance * clutter_eotf_get_default_luminance (ClutterEOTF eotf);
CLUTTER_EXPORT
const ClutterPrimaries * clutter_colorspace_to_primaries (ClutterColorspace colorspace);
CLUTTER_EXPORT
void clutter_primaries_ensure_normalized_range (ClutterPrimaries *primaries);
G_END_DECLS