AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
85950afbbd
gtk2/gsk/gskenums.h

212 lines
7.3 KiB
C
Raw Normal View History

Initial implementation of GSK rendering pipeline GSK is conceptually split into two scene graphs: * a simple rendering tree of operations * a complex set of logical layers The latter is built on the former, and adds convenience and high level API for application developers. The lower layer, though, is what gets transformed into the rendering pipeline, as it's simple and thus can be transformed into appropriate rendering commands with minimal state changes. The lower layer is also suitable for reuse from more complex higher layers, like the CSS machinery in GTK, without necessarily port those layers to the GSK high level API. This lower layer is based on GskRenderNode instances, which represent the tree of rendering operations; and a GskRenderer instance, which takes the render nodes and submits them (after potentially reordering and transforming them to a more appropriate representation) to the underlying graphic system.
2016-03-17 13:48:19 +00:00
/* GSK - The GTK Scene Kit
* Copyright 2016 Endless
*
* 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/>.
*/
#ifndef __GSK_ENUMS_H__
#define __GSK_ENUMS_H__
Use a single compilation symbol We use a compilation symbol in our build to allow the inclusion of specific headers while building GTK, to avoid the need to include only the global header. Each namespace has its own compilation symbol because we used to have different libraries, and strict symbol visibility between libraries; now that we have a single library, and we can use private symbols across namespaces while building GTK, we should have a single compilation symbol, and simplify the build rules.
2019-11-27 13:33:43 +00:00
#if !defined (__GSK_H_INSIDE__) && !defined (GTK_COMPILATION)
Initial implementation of GSK rendering pipeline GSK is conceptually split into two scene graphs: * a simple rendering tree of operations * a complex set of logical layers The latter is built on the former, and adds convenience and high level API for application developers. The lower layer, though, is what gets transformed into the rendering pipeline, as it's simple and thus can be transformed into appropriate rendering commands with minimal state changes. The lower layer is also suitable for reuse from more complex higher layers, like the CSS machinery in GTK, without necessarily port those layers to the GSK high level API. This lower layer is based on GskRenderNode instances, which represent the tree of rendering operations; and a GskRenderer instance, which takes the render nodes and submits them (after potentially reordering and transforming them to a more appropriate representation) to the underlying graphic system.
2016-03-17 13:48:19 +00:00
#error "Only <gsk/gsk.h> can be included directly."
#endif
gsk: Add GskRenderNodeType For now, this is unused.
2016-12-10 20:42:01 +00:00
/**
* GskRenderNodeType:
* @GSK_NOT_A_RENDER_NODE: Error type. No node will ever have this type.
* @GSK_CONTAINER_NODE: A node containing a stack of children
* @GSK_CAIRO_NODE: A node drawing a #cairo_surface_t
gsk: Add gsk_color_node_new()
2016-12-13 02:35:56 +00:00
* @GSK_COLOR_NODE: A node drawing a single color rectangle
gsk: Implement linear gradient render nodes
2016-12-15 04:42:31 +00:00
* @GSK_LINEAR_GRADIENT_NODE: A node drawing a linear gradient
Cosmetic change
2017-09-21 01:16:45 +00:00
* @GSK_REPEATING_LINEAR_GRADIENT_NODE: A node drawing a repeating linear gradient
gsk: Add GskBorderNode The node draws a solid CSS border, which can be used to cover everything but dashed and dotted borders (double, groove, inset, ...). For different border styles, we overlay multiple nodes and set their colors to transparent for sides with non-matching styles.
2016-12-18 17:14:53 +00:00
* @GSK_BORDER_NODE: A node stroking a border around an area
Partially revert GskTexture → GdkTexture rename Excessive use of sed when moving GskTexture to GDK; the GskTextureNode should still live under the GSK namespace.
2017-11-04 15:03:03 +00:00
* @GSK_TEXTURE_NODE: A node drawing a #GdkTexture
gsk: Add GskInsetShadowNode And again lots of shadow code gets copied to GSK. But we're now almost at a stage where widget-factory does not use cairo nodes anymore.
2016-12-19 04:13:42 +00:00
* @GSK_INSET_SHADOW_NODE: A node drawing an inset shadow
gsk: Add GskOutsetShadowNode
2016-12-19 14:39:43 +00:00
* @GSK_OUTSET_SHADOW_NODE: A node drawing an outset shadow
Cosmetic change
2017-09-21 01:16:45 +00:00
* @GSK_TRANSFORM_NODE: A node that renders its child after applying a matrix transform
gsk: Replace gsk_render_node_set_opacity() ... with gsk_opacity_node_new(). Also implement support for opacity in gtk_widget_snapshot() using this new node.
2016-12-13 04:49:57 +00:00
* @GSK_OPACITY_NODE: A node that changes the opacity of its child
gsk: Add GskRepeatNode Also add gtk_snapshot_push_repeat() and use that to draw backgrounds. With that change, CSS background snapshots are created without Cairo nodes.
2017-01-01 18:52:18 +00:00
* @GSK_COLOR_MATRIX_NODE: A node that applies a color matrix to every pixel
* @GSK_REPEAT_NODE: A node that repeats the child's contents
gsk: Add gsk_clip_node_new() The node is a simple clipping node: It does a rectangular clip of its contents.
2016-12-13 08:37:51 +00:00
* @GSK_CLIP_NODE: A node that clips its child to a rectangular area
gsk: Add GskRoundedRect It's essentially a port of GtkRoundedBox to graphene.
2016-12-13 18:02:12 +00:00
* @GSK_ROUNDED_CLIP_NODE: A node that clips its child to a rounded rectangle
gsk: Add GskShadowNode ... and make the icon rendering code use it. This requires moving even more shadow renering code into GSK, but so be it. At least the "shadows not implemented" warning is now gone!
2016-12-18 23:45:35 +00:00
* @GSK_SHADOW_NODE: A node that draws a shadow below its child
gskenums: Fix typo/grammar in GskRenderNodeType doc
2017-08-29 22:10:14 +00:00
* @GSK_BLEND_NODE: A node that blends two children together
* @GSK_CROSS_FADE_NODE: A node that cross-fades between two children
Add a render node for text This is just a wrapper around a PangoGlyphString + PangoFont. Basically, the arguments that are passed to pango_renderer_draw_glyphs.
2017-08-29 21:28:10 +00:00
* @GSK_TEXT_NODE: A node containing a glyph string
gsk: Add a blur node For now, this has just a fallback implementation using the typical box filter approximation.
2017-09-03 03:49:34 +00:00
* @GSK_BLUR_NODE: A node that applies a blur
gsk: Add GskRenderNodeType For now, this is unused.
2016-12-10 20:42:01 +00:00
*
* The type of a node determines what the node is rendering.
**/
typedef enum {
GSK_NOT_A_RENDER_NODE = 0,
GSK_CONTAINER_NODE,
GSK_CAIRO_NODE,
gsk: Add gsk_color_node_new()
2016-12-13 02:35:56 +00:00
GSK_COLOR_NODE,
gsk: Implement linear gradient render nodes
2016-12-15 04:42:31 +00:00
GSK_LINEAR_GRADIENT_NODE,
GSK_REPEATING_LINEAR_GRADIENT_NODE,
gsk: Add GskBorderNode The node draws a solid CSS border, which can be used to cover everything but dashed and dotted borders (double, groove, inset, ...). For different border styles, we overlay multiple nodes and set their colors to transparent for sides with non-matching styles.
2016-12-18 17:14:53 +00:00
GSK_BORDER_NODE,
Partially revert GskTexture → GdkTexture rename Excessive use of sed when moving GskTexture to GDK; the GskTextureNode should still live under the GSK namespace.
2017-11-04 15:03:03 +00:00
GSK_TEXTURE_NODE,
gsk: Add GskInsetShadowNode And again lots of shadow code gets copied to GSK. But we're now almost at a stage where widget-factory does not use cairo nodes anymore.
2016-12-19 04:13:42 +00:00
GSK_INSET_SHADOW_NODE,
gsk: Add GskOutsetShadowNode
2016-12-19 14:39:43 +00:00
GSK_OUTSET_SHADOW_NODE,
gsk: Replace gsk_render_node_set_opacity() ... with gsk_opacity_node_new(). Also implement support for opacity in gtk_widget_snapshot() using this new node.
2016-12-13 04:49:57 +00:00
GSK_TRANSFORM_NODE,
gsk: Add gsk_clip_node_new() The node is a simple clipping node: It does a rectangular clip of its contents.
2016-12-13 08:37:51 +00:00
GSK_OPACITY_NODE,
gsk: Add GskColorMatrixNode This node essentially implements the feColorMatrix SVG filter. I got the idea yesterday after looking at the opacity implementation. It can be used for opacity (not sure if we want to) and to implement a bunch of the CSS filters.
2016-12-31 00:13:19 +00:00
GSK_COLOR_MATRIX_NODE,
gsk: Add GskRepeatNode Also add gtk_snapshot_push_repeat() and use that to draw backgrounds. With that change, CSS background snapshots are created without Cairo nodes.
2017-01-01 18:52:18 +00:00
GSK_REPEAT_NODE,
gsk: Add GskRoundedRect It's essentially a port of GtkRoundedBox to graphene.
2016-12-13 18:02:12 +00:00
GSK_CLIP_NODE,
gsk: Add blend nodes Implement blend mode support in GTK background compositing with it.
2016-12-15 03:24:37 +00:00
GSK_ROUNDED_CLIP_NODE,
gsk: Add GskShadowNode ... and make the icon rendering code use it. This requires moving even more shadow renering code into GSK, but so be it. At least the "shadows not implemented" warning is now gone!
2016-12-18 23:45:35 +00:00
GSK_SHADOW_NODE,
gsk: Add cross-fade node And implement stack crossfades with it.
2016-12-17 06:44:10 +00:00
GSK_BLEND_NODE,
Add a render node for text This is just a wrapper around a PangoGlyphString + PangoFont. Basically, the arguments that are passed to pango_renderer_draw_glyphs.
2017-08-29 21:28:10 +00:00
GSK_CROSS_FADE_NODE,
gsk: Add a blur node For now, this has just a fallback implementation using the typical box filter approximation.
2017-09-03 03:49:34 +00:00
GSK_TEXT_NODE,
rendernode: Fix serializing Adding the offset node broke serialization in 2 ways: 1. We store the enum value in the node, so make sure to not change it for existing values 2. The offset node was missing in the deserialization lookup table
2018-03-26 17:41:38 +00:00
GSK_BLUR_NODE,
gsk: Add GskDebugNode
2018-04-23 22:41:48 +00:00
GSK_DEBUG_NODE
gsk: Add GskRenderNodeType For now, this is unused.
2016-12-10 20:42:01 +00:00
} GskRenderNodeType;
Initial implementation of GSK rendering pipeline GSK is conceptually split into two scene graphs: * a simple rendering tree of operations * a complex set of logical layers The latter is built on the former, and adds convenience and high level API for application developers. The lower layer, though, is what gets transformed into the rendering pipeline, as it's simple and thus can be transformed into appropriate rendering commands with minimal state changes. The lower layer is also suitable for reuse from more complex higher layers, like the CSS machinery in GTK, without necessarily port those layers to the GSK high level API. This lower layer is based on GskRenderNode instances, which represent the tree of rendering operations; and a GskRenderer instance, which takes the render nodes and submits them (after potentially reordering and transforming them to a more appropriate representation) to the underlying graphic system.
2016-03-17 13:48:19 +00:00
/**
* GskScalingFilter:
* @GSK_SCALING_FILTER_LINEAR: linear interpolation filter
* @GSK_SCALING_FILTER_NEAREST: nearest neighbor interpolation filter
* @GSK_SCALING_FILTER_TRILINEAR: linear interpolation along each axis,
* plus mipmap generation, with linear interpolation along the mipmap
* levels
*
* The filters used when scaling texture data.
*
* The actual implementation of each filter is deferred to the
* rendering pipeline.
*/
typedef enum {
GSK_SCALING_FILTER_LINEAR,
GSK_SCALING_FILTER_NEAREST,
GSK_SCALING_FILTER_TRILINEAR
} GskScalingFilter;
gsk: Make GskBlendMode enumeration public
2016-07-01 11:02:43 +00:00
/**
* GskBlendMode:
* @GSK_BLEND_MODE_DEFAULT: The default blend mode, which specifies no blending
* @GSK_BLEND_MODE_MULTIPLY: The source color is multiplied by the destination
* and replaces the destination
Small fixes for the docs Set titles and short descriptions for the sections.
2016-08-07 03:08:04 +00:00
* @GSK_BLEND_MODE_SCREEN: ...
gsk: Make GskBlendMode enumeration public
2016-07-01 11:02:43 +00:00
* @GSK_BLEND_MODE_OVERLAY: ...
* @GSK_BLEND_MODE_DARKEN: ...
* @GSK_BLEND_MODE_LIGHTEN: ...
* @GSK_BLEND_MODE_COLOR_DODGE: ...
* @GSK_BLEND_MODE_COLOR_BURN: ...
* @GSK_BLEND_MODE_HARD_LIGHT: ...
* @GSK_BLEND_MODE_SOFT_LIGHT: ...
* @GSK_BLEND_MODE_DIFFERENCE: ...
* @GSK_BLEND_MODE_EXCLUSION: ...
gsk: Add missing blend modes This brings GSK blend modes in line with the CSS spec.
2016-12-15 03:19:03 +00:00
* @GSK_BLEND_MODE_COLOR: ...
* @GSK_BLEND_MODE_HUE: ...
* @GSK_BLEND_MODE_SATURATION: ...
* @GSK_BLEND_MODE_LUMINOSITY: ...
gsk: Make GskBlendMode enumeration public
2016-07-01 11:02:43 +00:00
*
* The blend modes available for render nodes.
*
* The implementation of each blend mode is deferred to the
* rendering pipeline.
*/
typedef enum {
GSK_BLEND_MODE_DEFAULT = 0,
GSK_BLEND_MODE_MULTIPLY,
GSK_BLEND_MODE_SCREEN,
GSK_BLEND_MODE_OVERLAY,
GSK_BLEND_MODE_DARKEN,
GSK_BLEND_MODE_LIGHTEN,
GSK_BLEND_MODE_COLOR_DODGE,
GSK_BLEND_MODE_COLOR_BURN,
GSK_BLEND_MODE_HARD_LIGHT,
GSK_BLEND_MODE_SOFT_LIGHT,
GSK_BLEND_MODE_DIFFERENCE,
gsk: Add missing blend modes This brings GSK blend modes in line with the CSS spec.
2016-12-15 03:19:03 +00:00
GSK_BLEND_MODE_EXCLUSION,
GSK_BLEND_MODE_COLOR,
GSK_BLEND_MODE_HUE,
GSK_BLEND_MODE_SATURATION,
GSK_BLEND_MODE_LUMINOSITY
gsk: Make GskBlendMode enumeration public
2016-07-01 11:02:43 +00:00
} GskBlendMode;
gsk: Add GskRoundedRect It's essentially a port of GtkRoundedBox to graphene.
2016-12-13 18:02:12 +00:00
/**
* GskCorner:
* @GSK_CORNER_TOP_LEFT: The top left corner
* @GSK_CORNER_TOP_RIGHT: The top right corner
* @GSK_CORNER_BOTTOM_RIGHT: The bottom right corner
* @GSK_CORNER_BOTTOM_LEFT: The bottom left corner
*
* The corner indices used by #GskRoundedRect.
*/
typedef enum {
GSK_CORNER_TOP_LEFT,
GSK_CORNER_TOP_RIGHT,
GSK_CORNER_BOTTOM_RIGHT,
GSK_CORNER_BOTTOM_LEFT
} GskCorner;
gsk: Add docs and error handling to serialization API
2016-12-23 07:03:36 +00:00
/**
* GskSerializationError:
* @GSK_SERIALIZATION_UNSUPPORTED_FORMAT: The format can not be
* identified
* @GSK_SERIALIZATION_UNSUPPORTED_VERSION: The version of the data
* is not understood
* @GSK_SERIALIZATION_INVALID_DATA: The given data may not exist in
* a proper serialization
*
* Errors that can happen during (de)serialization.
*/
typedef enum {
GSK_SERIALIZATION_UNSUPPORTED_FORMAT,
GSK_SERIALIZATION_UNSUPPORTED_VERSION,
GSK_SERIALIZATION_INVALID_DATA
} GskSerializationError;
transform: Make category public API Also rename it from GskMatrixCategory to GskTransformCategory.
2019-03-01 06:51:23 +00:00
/**
* GskTransformCategory:
* @GSK_TRANSFORM_CATEGORY_UNKNOWN: The category of the matrix has not been
* determined.
* @GSK_TRANSFORM_CATEGORY_ANY: Analyzing the matrix concluded that it does
* not fit in any other category.
gsk: API docs fixes gsk/gskenums.h:181: Error: Gsk: multiple "@GSK_TRANSFORM_CATEGORY_2D" parameters for identifier "GskTransformCategory": * @GSK_TRANSFORM_CATEGORY_2D: The matrix is a 2D matrix. This is equivalent ^ gsk/gsktransform.c:1342: Warning: Gsk: gsk_transform_to_2d: unknown parameter 'm' in documentation comment, should be 'self' gsk/gsktransform.c:1368: Warning: Gsk: gsk_transform_to_2d: invalid return annotation gsk/gsktransform.c:1461: Warning: Gsk: gsk_transform_to_translate: unknown parameter 'm' in documentation comment, should be 'self'
2019-03-07 15:29:28 +00:00
* @GSK_TRANSFORM_CATEGORY_3D: The matrix is a 3D matrix. This means that
transform: Make category public API Also rename it from GskMatrixCategory to GskTransformCategory.
2019-03-01 06:51:23 +00:00
* the w column (the last column) has the values (0, 0, 0, 1).
* @GSK_TRANSFORM_CATEGORY_2D: The matrix is a 2D matrix. This is equivalent
* to graphene_matrix_is_2d() returning %TRUE. In particular, this
* means that Cairo can deal with the matrix.
* @GSK_TRANSFORM_CATEGORY_2D_AFFINE: The matrix is a combination of 2D scale
* and 2D translation operations. In particular, this means that any
* rectangle can be transformed exactly using this matrix.
* @GSK_TRANSFORM_CATEGORY_2D_TRANSLATE: The matrix is a 2D translation.
* @GSK_TRANSFORM_CATEGORY_IDENTITY: The matrix is the identity matrix.
*
* The categories of matrices relevant for GSK and GTK. Note that any
* category includes matrices of all later categories. So if you want
* to for example check if a matrix is a 2D matrix,
* `category >= GSK_TRANSFORM_CATEGORY_2D` is the way to do this.
*
* Also keep in mind that rounding errors may cause matrices to not
* conform to their categories. Otherwise, matrix operations done via
* mutliplication will not worsen categories. So for the matrix
* multiplication `C = A * B`, `category(C) = MIN (category(A), category(B))`.
*/
typedef enum
{
GSK_TRANSFORM_CATEGORY_UNKNOWN,
GSK_TRANSFORM_CATEGORY_ANY,
GSK_TRANSFORM_CATEGORY_3D,
GSK_TRANSFORM_CATEGORY_2D,
GSK_TRANSFORM_CATEGORY_2D_AFFINE,
GSK_TRANSFORM_CATEGORY_2D_TRANSLATE,
GSK_TRANSFORM_CATEGORY_IDENTITY
} GskTransformCategory;
Initial implementation of GSK rendering pipeline GSK is conceptually split into two scene graphs: * a simple rendering tree of operations * a complex set of logical layers The latter is built on the former, and adds convenience and high level API for application developers. The lower layer, though, is what gets transformed into the rendering pipeline, as it's simple and thus can be transformed into appropriate rendering commands with minimal state changes. The lower layer is also suitable for reuse from more complex higher layers, like the CSS machinery in GTK, without necessarily port those layers to the GSK high level API. This lower layer is based on GskRenderNode instances, which represent the tree of rendering operations; and a GskRenderer instance, which takes the render nodes and submits them (after potentially reordering and transforming them to a more appropriate representation) to the underlying graphic system.
2016-03-17 13:48:19 +00:00
#endif /* __GSK_TYPES_H__ */
Reference in New Issue Copy Permalink