Blender V5.3
blender::PlayState Struct Reference

Public Attributes

PlayDisplayContext display_ctx
float zoom
short direction
short next_frame
bool once
bool pingpong
bool no_frame_skip
bool show_frame_indicator
bool single_step
bool wait
bool stopped
bool go
bool loading
bool draw_flip [2]
int frame_step
ListBaseT< PlayAnimPict > picsbase
PlayAnimPict * picture
int2 ibuf_size
int font_id
int font_size
int argc_next
char ** argv_next
bool need_frame_update
int frame_cursor_x
GhostData ghost_data

Detailed Description

The current state of the player.

Warning
Don't store results of parsing command-line arguments in this struct if they need to persist across playing back different files as these will be cleared when playing other files (drag & drop).

Definition at line 230 of file wm_playanim.cc.

Member Data Documentation

◆ argc_next

int blender::PlayState::argc_next

Restarts player for file drop (drag & drop).

Definition at line 284 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ argv_next

char** blender::PlayState::argv_next

Definition at line 285 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ direction

short blender::PlayState::direction

Playback direction (-1, 1).

Definition at line 238 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ display_ctx

PlayDisplayContext blender::PlayState::display_ctx

Context for displaying images (color spaces & display-size).

Definition at line 232 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_toscreen(), blender::playanim_window_font_scale_from_dpi(), and blender::wm_main_playanim_intern().

◆ draw_flip

bool blender::PlayState::draw_flip[2]

X/Y image flip (set via key bindings).

Definition at line 266 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_toscreen(), and blender::wm_main_playanim_intern().

◆ font_id

int blender::PlayState::font_id

◆ font_size

int blender::PlayState::font_size

◆ frame_cursor_x

int blender::PlayState::frame_cursor_x

The current frame calculated by scrubbing the mouse cursor.

Definition at line 290 of file wm_playanim.cc.

Referenced by blender::playanim_change_frame(), and blender::playanim_change_frame_tag().

◆ frame_step

int blender::PlayState::frame_step

The number of frames to step each update (default to 1, command line argument).

Definition at line 269 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_toscreen(), and blender::wm_main_playanim_intern().

◆ ghost_data

◆ go

bool blender::PlayState::go

When disabled the current animation will exit, after this either the application exits or a new animation window is opened.

This is used so drag & drop can load new files which setup a newly created animation window.

Definition at line 262 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ ibuf_size

int2 blender::PlayState::ibuf_size

Image size in pixels, set once at the start.

Definition at line 278 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_window_zoom(), and blender::wm_main_playanim_intern().

◆ loading

bool blender::PlayState::loading

True when waiting for images to load.

Definition at line 264 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_toscreen(), and blender::wm_main_playanim_intern().

◆ need_frame_update

bool blender::PlayState::need_frame_update

Force update when scrubbing with the cursor.

Definition at line 288 of file wm_playanim.cc.

Referenced by blender::playanim_change_frame(), and blender::playanim_change_frame_tag().

◆ next_frame

short blender::PlayState::next_frame

Set the next frame to implement frame stepping (using shortcuts).

Definition at line 240 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_change_frame(), and blender::wm_main_playanim_intern().

◆ no_frame_skip

bool blender::PlayState::no_frame_skip

Disable frame skipping.

Definition at line 247 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ once

bool blender::PlayState::once

Playback once then wait.

Definition at line 243 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ picsbase

ListBaseT<PlayAnimPict> blender::PlayState::picsbase

◆ picture

PlayAnimPict* blender::PlayState::picture

◆ pingpong

bool blender::PlayState::pingpong

Play forwards/backwards.

Definition at line 245 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ show_frame_indicator

bool blender::PlayState::show_frame_indicator

Display current frame over the window.

Definition at line 249 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_toscreen(), and blender::wm_main_playanim_intern().

◆ single_step

bool blender::PlayState::single_step

Single-frame stepping has been enabled (frame loading and update pending).

Definition at line 251 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_change_frame(), and blender::wm_main_playanim_intern().

◆ stopped

bool blender::PlayState::stopped

Playback stopped state once stop/start variables have been handled.

Definition at line 255 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), and blender::wm_main_playanim_intern().

◆ wait

bool blender::PlayState::wait

Playback has stopped the image has been displayed.

Definition at line 253 of file wm_playanim.cc.

Referenced by blender::ghost_event_proc(), blender::playanim_change_frame(), and blender::wm_main_playanim_intern().

◆ zoom

float blender::PlayState::zoom

The documentation for this struct was generated from the following file: