Blender V4.3
Classes | Macros | Typedefs | Enumerations
DNA_grease_pencil_types.h File Reference
Blender | Blender » DNA, RNA and .blend access » Struct DNA (File Format)
#include "DNA_ID.h"
#include "DNA_curve_types.h"
#include "DNA_curves_types.h"
#include "DNA_listBase.h"

Go to the source code of this file.

Classes

struct  GreasePencilDrawingBase
 
struct  GreasePencilDrawing
 
struct  GreasePencilDrawingReference
 
struct  GreasePencilFrame
 
struct  GreasePencilLayerFramesMapStorage
 
struct  GreasePencilLayerMask
 
struct  GreasePencilLayerTreeNode
 
struct  GreasePencilLayer
 
struct  GreasePencilLayerTreeGroup
 
struct  GreasePencilOnionSkinningSettings
 
struct  GreasePencil
 

Macros

#define GREASE_PENCIL_ONION_SKINNING_FILTER_ALL
 

Typedefs

typedef struct GreasePencilRuntimeHandle GreasePencilRuntimeHandle
 
typedef struct GreasePencilDrawingRuntimeHandle GreasePencilDrawingRuntimeHandle
 
typedef struct GreasePencilLayerRuntimeHandle GreasePencilLayerRuntimeHandle
 
typedef struct GreasePencilLayerGroupRuntimeHandle GreasePencilLayerGroupRuntimeHandle
 
typedef enum GreasePencilStrokeCapType GreasePencilStrokeCapType
 
typedef enum GreasePencilDrawingType GreasePencilDrawingType
 
typedef enum GreasePencilDrawingBaseFlag GreasePencilDrawingBaseFlag
 
typedef struct GreasePencilDrawingBase GreasePencilDrawingBase
 
typedef struct GreasePencilDrawing GreasePencilDrawing
 
typedef struct GreasePencilDrawingReference GreasePencilDrawingReference
 
typedef enum GreasePencilFrameFlag GreasePencilFrameFlag
 
typedef struct GreasePencilFrame GreasePencilFrame
 
typedef enum GreasePencilLayerFramesMapStorageFlag GreasePencilLayerFramesMapStorageFlag
 
typedef struct GreasePencilLayerFramesMapStorage GreasePencilLayerFramesMapStorage
 
typedef enum GreasePencilLayerMaskFlag GreasePencilLayerMaskFlag
 
typedef struct GreasePencilLayerMask GreasePencilLayerMask
 
typedef enum GreasePencilLayerBlendMode GreasePencilLayerBlendMode
 
typedef enum GreasePencilLayerTreeNodeType GreasePencilLayerTreeNodeType
 
typedef enum GreasePencilLayerTreeNodeFlag GreasePencilLayerTreeNodeFlag
 
typedef struct GreasePencilLayerTreeNode GreasePencilLayerTreeNode
 
typedef struct GreasePencilLayer GreasePencilLayer
 
typedef enum GroupColorTag GroupColorTag
 
typedef struct GreasePencilLayerTreeGroup GreasePencilLayerTreeGroup
 
typedef enum GreasePencilFlag GreasePencilFlag
 
typedef enum GreasePencilOnionSkinningMode GreasePencilOnionSkinningMode
 
typedef enum GreasePencilOnionSkinningFlag GreasePencilOnionSkinningFlag
 
typedef enum GreasePencilOnionSkinningFilter GreasePencilOnionSkinningFilter
 
typedef struct GreasePencilOnionSkinningSettings GreasePencilOnionSkinningSettings
 
typedef struct GreasePencil GreasePencil
 

Enumerations

enum  GreasePencilStrokeCapType { GP_STROKE_CAP_TYPE_ROUND = 0 , GP_STROKE_CAP_TYPE_FLAT = 1 , GP_STROKE_CAP_TYPE_MAX }
 
enum  GreasePencilDrawingType { GP_DRAWING = 0 , GP_DRAWING_REFERENCE = 1 }
 
enum  GreasePencilDrawingBaseFlag { GreasePencilDrawingBaseFlag_TODO }
 
enum  GreasePencilFrameFlag { GP_FRAME_SELECTED = (1 << 0) , GP_FRAME_IMPLICIT_HOLD = (1 << 1) }
 
enum  GreasePencilLayerFramesMapStorageFlag { GP_LAYER_FRAMES_STORAGE_DIRTY = (1 << 0) }
 
enum  GreasePencilLayerMaskFlag { GP_LAYER_MASK_HIDE = (1 << 0) , GP_LAYER_MASK_INVERT = (1 << 1) }
 
enum  GreasePencilLayerBlendMode {
  GP_LAYER_BLEND_NONE = 0 , GP_LAYER_BLEND_HARDLIGHT = 1 , GP_LAYER_BLEND_ADD = 2 , GP_LAYER_BLEND_SUBTRACT = 3 ,
  GP_LAYER_BLEND_MULTIPLY = 4 , GP_LAYER_BLEND_DIVIDE = 5
}
 
enum  GreasePencilLayerTreeNodeType { GP_LAYER_TREE_LEAF = 0 , GP_LAYER_TREE_GROUP = 1 }
 
enum  GreasePencilLayerTreeNodeFlag {
  GP_LAYER_TREE_NODE_HIDE = (1 << 0) , GP_LAYER_TREE_NODE_LOCKED = (1 << 1) , GP_LAYER_TREE_NODE_SELECT = (1 << 2) , GP_LAYER_TREE_NODE_MUTE = (1 << 3) ,
  GP_LAYER_TREE_NODE_USE_LIGHTS = (1 << 4) , GP_LAYER_TREE_NODE_HIDE_ONION_SKINNING = (1 << 5) , GP_LAYER_TREE_NODE_EXPANDED = (1 << 6) , GP_LAYER_TREE_NODE_HIDE_MASKS = (1 << 7) ,
  GP_LAYER_TREE_NODE_DISABLE_MASKS_IN_VIEWLAYER = (1 << 8) , GP_LAYER_TREE_NODE_IGNORE_LOCKED_MATERIALS = (1 << 9)
}
 
enum  GroupColorTag {
  LAYERGROUP_COLOR_NONE = -1 , LAYERGROUP_COLOR_01 , LAYERGROUP_COLOR_02 , LAYERGROUP_COLOR_03 ,
  LAYERGROUP_COLOR_04 , LAYERGROUP_COLOR_05 , LAYERGROUP_COLOR_06 , LAYERGROUP_COLOR_07 ,
  LAYERGROUP_COLOR_08
}
 
enum  GreasePencilFlag { GREASE_PENCIL_ANIM_CHANNEL_EXPANDED = (1 << 0) , GREASE_PENCIL_AUTOLOCK_LAYERS = (1 << 1) , GREASE_PENCIL_STROKE_ORDER_3D = (1 << 2) }
 
enum  GreasePencilOnionSkinningMode { GP_ONION_SKINNING_MODE_ABSOLUTE = 0 , GP_ONION_SKINNING_MODE_RELATIVE = 1 , GP_ONION_SKINNING_MODE_SELECTED = 2 }
 
enum  GreasePencilOnionSkinningFlag { GP_ONION_SKINNING_USE_CUSTOM_COLORS = (1 << 0) , GP_ONION_SKINNING_USE_FADE = (1 << 1) , GP_ONION_SKINNING_SHOW_LOOP = (1 << 2) }
 
enum  GreasePencilOnionSkinningFilter {
  GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME = (1 << 0) , GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME = (1 << 1) , GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN = (1 << 2) , GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER = (1 << 3) ,
  GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD = (1 << 4)
}
 

Macro Definition Documentation

◆ GREASE_PENCIL_ONION_SKINNING_FILTER_ALL

#define GREASE_PENCIL_ONION_SKINNING_FILTER_ALL
Value:
(GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME | GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME | \
GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN | GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER | \
GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD)
GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD
@ GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD
Definition DNA_grease_pencil_types.h:397
GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER
@ GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER
Definition DNA_grease_pencil_types.h:396
GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME
@ GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME
Definition DNA_grease_pencil_types.h:393
GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN
@ GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN
Definition DNA_grease_pencil_types.h:395
GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME
@ GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME
Definition DNA_grease_pencil_types.h:394

Definition at line 400 of file DNA_grease_pencil_types.h.

Referenced by blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil(), and rna_def_grease_pencil_onion_skinning().

Typedef Documentation

◆ GreasePencil

typedef struct GreasePencil GreasePencil

The grease pencil data-block.

◆ GreasePencilDrawing

typedef struct GreasePencilDrawing GreasePencilDrawing

A grease pencil drawing is a set of strokes. The data is stored using the CurvesGeometry data structure and the custom attributes within it.

◆ GreasePencilDrawingBase

typedef struct GreasePencilDrawingBase GreasePencilDrawingBase

Base class for drawings and drawing references (drawings from other objects).

◆ GreasePencilDrawingBaseFlag

typedef enum GreasePencilDrawingBaseFlag GreasePencilDrawingBaseFlag

Flag for drawings and drawing references. GreasePencilDrawingBase.flag

◆ GreasePencilDrawingReference

typedef struct GreasePencilDrawingReference GreasePencilDrawingReference

◆ GreasePencilDrawingRuntimeHandle

typedef struct GreasePencilDrawingRuntimeHandle GreasePencilDrawingRuntimeHandle

Definition at line 46 of file DNA_grease_pencil_types.h.

◆ GreasePencilDrawingType

typedef enum GreasePencilDrawingType GreasePencilDrawingType

Type of drawing data. If GP_DRAWING the node is a GreasePencilDrawing, if GP_DRAWING_REFERENCE the node is a GreasePencilDrawingReference.

◆ GreasePencilFlag

typedef enum GreasePencilFlag GreasePencilFlag

Flag for the grease pencil data-block. GreasePencil.flag

◆ GreasePencilFrame

typedef struct GreasePencilFrame GreasePencilFrame

A GreasePencilFrame is a single keyframe in the timeline. It references a drawing by index into the drawing array.

◆ GreasePencilFrameFlag

typedef enum GreasePencilFrameFlag GreasePencilFrameFlag

Flag for grease pencil frames. GreasePencilFrame.flag

◆ GreasePencilLayer

typedef struct GreasePencilLayer GreasePencilLayer

A grease pencil layer is a collection of drawings mapped to a specific time on the timeline.

◆ GreasePencilLayerBlendMode

typedef enum GreasePencilLayerBlendMode GreasePencilLayerBlendMode

Layer blending modes. GreasePencilLayer.blend_mode

◆ GreasePencilLayerFramesMapStorage

typedef struct GreasePencilLayerFramesMapStorage GreasePencilLayerFramesMapStorage

Storage for the Map in blender::bke::greasepencil::Layer. See the description there for more detail.

◆ GreasePencilLayerFramesMapStorageFlag

typedef enum GreasePencilLayerFramesMapStorageFlag GreasePencilLayerFramesMapStorageFlag

◆ GreasePencilLayerGroupRuntimeHandle

typedef struct GreasePencilLayerGroupRuntimeHandle GreasePencilLayerGroupRuntimeHandle

Definition at line 48 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerMask

typedef struct GreasePencilLayerMask GreasePencilLayerMask

A grease pencil layer mask stores the name of a layer that is the mask.

◆ GreasePencilLayerMaskFlag

typedef enum GreasePencilLayerMaskFlag GreasePencilLayerMaskFlag

Flag for layer masks. GreasePencilLayerMask.flag

◆ GreasePencilLayerRuntimeHandle

typedef struct GreasePencilLayerRuntimeHandle GreasePencilLayerRuntimeHandle

Definition at line 47 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerTreeGroup

typedef struct GreasePencilLayerTreeGroup GreasePencilLayerTreeGroup

◆ GreasePencilLayerTreeNode

typedef struct GreasePencilLayerTreeNode GreasePencilLayerTreeNode

◆ GreasePencilLayerTreeNodeFlag

typedef enum GreasePencilLayerTreeNodeFlag GreasePencilLayerTreeNodeFlag

Flags for layer tree nodes. GreasePencilLayerTreeNode.flag

◆ GreasePencilLayerTreeNodeType

typedef enum GreasePencilLayerTreeNodeType GreasePencilLayerTreeNodeType

Type of layer node. If GP_LAYER_TREE_LEAF the node is a GreasePencilLayerTreeLeaf, if GP_LAYER_TREE_GROUP the node is a GreasePencilLayerTreeGroup.

◆ GreasePencilOnionSkinningFilter

typedef enum GreasePencilOnionSkinningFilter GreasePencilOnionSkinningFilter

Flag for filtering the onion skinning per keyframe type. GreasePencilOnionSkinningSettings.filter

Note
needs to match order of eBezTriple_KeyframeType.

◆ GreasePencilOnionSkinningFlag

typedef enum GreasePencilOnionSkinningFlag GreasePencilOnionSkinningFlag

◆ GreasePencilOnionSkinningMode

typedef enum GreasePencilOnionSkinningMode GreasePencilOnionSkinningMode

Onion skinning mode. GreasePencilOnionSkinningSettings.mode

◆ GreasePencilOnionSkinningSettings

typedef struct GreasePencilOnionSkinningSettings GreasePencilOnionSkinningSettings

Per data-block Grease Pencil onion skinning settings.

◆ GreasePencilRuntimeHandle

typedef struct GreasePencilRuntimeHandle GreasePencilRuntimeHandle

Definition at line 45 of file DNA_grease_pencil_types.h.

◆ GreasePencilStrokeCapType

typedef enum GreasePencilStrokeCapType GreasePencilStrokeCapType

◆ GroupColorTag

typedef enum GroupColorTag GroupColorTag

Enumeration Type Documentation

◆ GreasePencilDrawingBaseFlag

enum GreasePencilDrawingBaseFlag

Flag for drawings and drawing references. GreasePencilDrawingBase.flag

Enumerator
GreasePencilDrawingBaseFlag_TODO 

Definition at line 75 of file DNA_grease_pencil_types.h.

◆ GreasePencilDrawingType

enum GreasePencilDrawingType

Type of drawing data. If GP_DRAWING the node is a GreasePencilDrawing, if GP_DRAWING_REFERENCE the node is a GreasePencilDrawingReference.

Enumerator
GP_DRAWING 
GP_DRAWING_REFERENCE 

Definition at line 67 of file DNA_grease_pencil_types.h.

◆ GreasePencilFlag

enum GreasePencilFlag

Flag for the grease pencil data-block. GreasePencil.flag

Enumerator
GREASE_PENCIL_ANIM_CHANNEL_EXPANDED 
GREASE_PENCIL_AUTOLOCK_LAYERS 
GREASE_PENCIL_STROKE_ORDER_3D 

Definition at line 363 of file DNA_grease_pencil_types.h.

◆ GreasePencilFrameFlag

enum GreasePencilFrameFlag

Flag for grease pencil frames. GreasePencilFrame.flag

Enumerator
GP_FRAME_SELECTED 
GP_FRAME_IMPLICIT_HOLD 

Definition at line 133 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerBlendMode

enum GreasePencilLayerBlendMode

Layer blending modes. GreasePencilLayer.blend_mode

Enumerator
GP_LAYER_BLEND_NONE 
GP_LAYER_BLEND_HARDLIGHT 
GP_LAYER_BLEND_ADD 
GP_LAYER_BLEND_SUBTRACT 
GP_LAYER_BLEND_MULTIPLY 
GP_LAYER_BLEND_DIVIDE 

Definition at line 212 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerFramesMapStorageFlag

enum GreasePencilLayerFramesMapStorageFlag
Enumerator
GP_LAYER_FRAMES_STORAGE_DIRTY 

Definition at line 166 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerMaskFlag

enum GreasePencilLayerMaskFlag

Flag for layer masks. GreasePencilLayerMask.flag

Enumerator
GP_LAYER_MASK_HIDE 
GP_LAYER_MASK_INVERT 

Definition at line 188 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerTreeNodeFlag

enum GreasePencilLayerTreeNodeFlag

Flags for layer tree nodes. GreasePencilLayerTreeNode.flag

Enumerator
GP_LAYER_TREE_NODE_HIDE 
GP_LAYER_TREE_NODE_LOCKED 
GP_LAYER_TREE_NODE_SELECT 
GP_LAYER_TREE_NODE_MUTE 
GP_LAYER_TREE_NODE_USE_LIGHTS 
GP_LAYER_TREE_NODE_HIDE_ONION_SKINNING 
GP_LAYER_TREE_NODE_EXPANDED 
GP_LAYER_TREE_NODE_HIDE_MASKS 
GP_LAYER_TREE_NODE_DISABLE_MASKS_IN_VIEWLAYER 
GP_LAYER_TREE_NODE_IGNORE_LOCKED_MATERIALS 

Definition at line 234 of file DNA_grease_pencil_types.h.

◆ GreasePencilLayerTreeNodeType

enum GreasePencilLayerTreeNodeType

Type of layer node. If GP_LAYER_TREE_LEAF the node is a GreasePencilLayerTreeLeaf, if GP_LAYER_TREE_GROUP the node is a GreasePencilLayerTreeGroup.

Enumerator
GP_LAYER_TREE_LEAF 
GP_LAYER_TREE_GROUP 

Definition at line 226 of file DNA_grease_pencil_types.h.

◆ GreasePencilOnionSkinningFilter

enum GreasePencilOnionSkinningFilter

Flag for filtering the onion skinning per keyframe type. GreasePencilOnionSkinningSettings.filter

Note
needs to match order of eBezTriple_KeyframeType.
Enumerator
GP_ONION_SKINNING_FILTER_KEYTYPE_KEYFRAME 
GP_ONION_SKINNING_FILTER_KEYTYPE_EXTREME 
GP_ONION_SKINNING_FILTER_KEYTYPE_BREAKDOWN 
GP_ONION_SKINNING_FILTER_KEYTYPE_JITTER 
GP_ONION_SKINNING_FILTER_KEYTYPE_MOVEHOLD 

Definition at line 392 of file DNA_grease_pencil_types.h.

◆ GreasePencilOnionSkinningFlag

enum GreasePencilOnionSkinningFlag
Enumerator
GP_ONION_SKINNING_USE_CUSTOM_COLORS 
GP_ONION_SKINNING_USE_FADE 
GP_ONION_SKINNING_SHOW_LOOP 

Definition at line 378 of file DNA_grease_pencil_types.h.

◆ GreasePencilOnionSkinningMode

enum GreasePencilOnionSkinningMode

Onion skinning mode. GreasePencilOnionSkinningSettings.mode

Enumerator
GP_ONION_SKINNING_MODE_ABSOLUTE 
GP_ONION_SKINNING_MODE_RELATIVE 
GP_ONION_SKINNING_MODE_SELECTED 

Definition at line 372 of file DNA_grease_pencil_types.h.

◆ GreasePencilStrokeCapType

enum GreasePencilStrokeCapType
Enumerator
GP_STROKE_CAP_TYPE_ROUND 
GP_STROKE_CAP_TYPE_FLAT 
GP_STROKE_CAP_TYPE_MAX 

Definition at line 55 of file DNA_grease_pencil_types.h.

◆ GroupColorTag

enum GroupColorTag
Enumerator
LAYERGROUP_COLOR_NONE 
LAYERGROUP_COLOR_01 
LAYERGROUP_COLOR_02 
LAYERGROUP_COLOR_03 
LAYERGROUP_COLOR_04 
LAYERGROUP_COLOR_05 
LAYERGROUP_COLOR_06 
LAYERGROUP_COLOR_07 
LAYERGROUP_COLOR_08 

Definition at line 327 of file DNA_grease_pencil_types.h.

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0