GPencilFrame(bpy_struct)

base class — bpy_struct

class bpy.types.GPencilFrame(bpy_struct)

Collection of related sketches on a particular frame

frame_number

The frame on which this sketch appears

Type

int in [-1048574, 1048574], default 0

is_edited

Frame is being edited (painted on)

Type

boolean, default False

keyframe_type

Type of keyframe

  • KEYFRAME Keyframe – Normal keyframe, e.g. for key poses.

  • BREAKDOWN Breakdown – A breakdown pose, e.g. for transitions between key poses.

  • MOVING_HOLD Moving Hold – A keyframe that is part of a moving hold.

  • EXTREME Extreme – An ‘extreme’ pose, or some other purpose as needed.

  • JITTER Jitter – A filler or baked keyframe for keying on ones, or some other purpose as needed.

Type

enum in [‘KEYFRAME’, ‘BREAKDOWN’, ‘MOVING_HOLD’, ‘EXTREME’, ‘JITTER’], default ‘KEYFRAME’

select

Frame is selected for editing in the Dope Sheet

Type

boolean, default False

strokes

Freehand curves defining the sketch on this frame

Type

GPencilStrokes bpy_prop_collection of GPencilStroke, (readonly)

clear()

Remove all the grease pencil frame data

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References