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
ListBase	picsbase
struct PlayAnimPict *	picture
blender::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 205 of file wm_playanim.cc.

Member Data Documentation

argc_next

int PlayState::argc_next

Restarts player for file drop (drag & drop).

Definition at line 259 of file wm_playanim.cc.

Referenced by ghost_event_proc().

argv_next

char** PlayState::argv_next

Definition at line 260 of file wm_playanim.cc.

Referenced by ghost_event_proc().

direction

short PlayState::direction

Playback direction (-1, 1).

Definition at line 213 of file wm_playanim.cc.

Referenced by ghost_event_proc().

display_ctx

PlayDisplayContext PlayState::display_ctx

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

Definition at line 207 of file wm_playanim.cc.

Referenced by ghost_event_proc(), playanim_toscreen(), and playanim_window_font_scale_from_dpi().

draw_flip

bool PlayState::draw_flip[2]

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

Definition at line 241 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_toscreen().

font_id

int PlayState::font_id

Mono-space font ID.

Definition at line 255 of file wm_playanim.cc.

Referenced by playanim_toscreen(), and playanim_window_font_scale_from_dpi().

font_size

int PlayState::font_size

Definition at line 256 of file wm_playanim.cc.

Referenced by playanim_window_font_scale_from_dpi().

frame_cursor_x

int PlayState::frame_cursor_x

The current frame calculated by scrubbing the mouse cursor.

Definition at line 265 of file wm_playanim.cc.

Referenced by playanim_change_frame(), and playanim_change_frame_tag().

frame_step

int PlayState::frame_step

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

Definition at line 244 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_toscreen().

ghost_data

GhostData PlayState::ghost_data

Definition at line 267 of file wm_playanim.cc.

Referenced by ghost_event_proc(), playanim_change_frame(), playanim_toscreen(), playanim_window_font_scale_from_dpi(), and playanim_window_zoom().

go

bool 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 237 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and wm_main_playanim_intern().

ibuf_size

blender::int2 PlayState::ibuf_size

Image size in pixels, set once at the start.

Definition at line 253 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_window_zoom().

loading

bool PlayState::loading

True when waiting for images to load.

Definition at line 239 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_toscreen().

need_frame_update

bool PlayState::need_frame_update

Force update when scrubbing with the cursor.

Definition at line 263 of file wm_playanim.cc.

Referenced by playanim_change_frame(), and playanim_change_frame_tag().

next_frame

short PlayState::next_frame

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

Definition at line 215 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_change_frame().

no_frame_skip

bool PlayState::no_frame_skip

Disable frame skipping.

Definition at line 222 of file wm_playanim.cc.

Referenced by ghost_event_proc().

once

bool PlayState::once

Playback once then wait.

Definition at line 218 of file wm_playanim.cc.

Referenced by ghost_event_proc().

picsbase

ListBase PlayState::picsbase

Picture PlayAnimPict, list (both image-sequence or videos) in-memory.

Definition at line 247 of file wm_playanim.cc.

Referenced by ghost_event_proc(), playanim_audio_resume(), playanim_change_frame(), and playanim_toscreen().

picture

struct PlayAnimPict* PlayState::picture

Current frame (picture).

Definition at line 250 of file wm_playanim.cc.

Referenced by ghost_event_proc(), playanim_audio_resume(), and playanim_change_frame().

pingpong

bool PlayState::pingpong

Play forwards/backwards.

Definition at line 220 of file wm_playanim.cc.

Referenced by ghost_event_proc().

show_frame_indicator

bool PlayState::show_frame_indicator

Display current frame over the window.

Definition at line 224 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_toscreen().

single_step

bool PlayState::single_step

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

Definition at line 226 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_change_frame().

stopped

bool PlayState::stopped

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

Definition at line 230 of file wm_playanim.cc.

Referenced by ghost_event_proc().

wait

bool PlayState::wait

Playback has stopped the image has been displayed.

Definition at line 228 of file wm_playanim.cc.

Referenced by ghost_event_proc(), and playanim_change_frame().

zoom

float PlayState::zoom

Current zoom level.

Definition at line 210 of file wm_playanim.cc.

Referenced by ghost_event_proc(), playanim_toscreen(), and playanim_window_zoom().

---

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

• wm_playanim.cc