Blender V5.3
BlenderSession Class Reference

#include <session.h>

Public Member Functions

 BlenderSession (blender::RenderEngine &b_engine, blender::UserDef &b_userpref, blender::Main &b_data, bool preview_osl)
 BlenderSession (blender::RenderEngine &b_engine, blender::UserDef &b_userpref, blender::Main &b_data, blender::bScreen *b_screen, blender::View3D *b_v3d, blender::RegionView3D *b_rv3d, const int width, int height)
 ~BlenderSession ()
void create_session ()
void free_session ()
void reset_session (blender::Main &b_data, blender::Depsgraph &b_depsgraph)
void render (blender::Depsgraph &b_depsgraph)
void render_frame_finish ()
void bake (blender::Depsgraph &b_depsgraph_, blender::Object &b_object, const string &bake_type, const int bake_filter, const int bake_width, const int bake_height)
void full_buffer_written (string_view filename)
void synchronize (blender::Depsgraph &b_depsgraph)
void draw (blender::bScreen &b_screen, blender::SpaceImage &space_image)
void view_draw (const int w, const int h)
void view_pause (const bool pause)
void tag_redraw ()
void tag_update ()
void get_status (string &status, string &substatus)
void get_progress (double &progress, double &total_time, double &render_time)
void test_cancel ()
void update_status_progress ()
void update_bake_progress ()

Public Attributes

bool background
bool view_paused = false
unique_ptr< Session > session
Scene * scene
unique_ptr< BlenderSync > sync
double last_redraw_time
blender::RenderEngine & b_engine
blender::UserDef & b_userpref
blender::Main * b_data
blender::RenderData * b_render
blender::Depsgraph * b_depsgraph
blender::Scene * b_scene
blender::bScreen * b_screen
blender::View3D * b_v3d
blender::RegionView3D * b_rv3d
string b_rlay_name
string b_rview_name
string last_status
string last_error
double last_progress
double last_status_time
int width
int height
float pixelsize
bool preview_osl
double start_resize_time
bool use_developer_ui

Static Public Attributes

static DeviceTypeMask device_override = DEVICE_MASK_ALL
static bool headless = false
static bool print_render_stats = false

Protected Member Functions

void stamp_view_layer_metadata (Scene *scene, const string &view_layer_name)
bool check_and_report_session_error ()
void builtin_images_load ()
void free_blender_memory_if_possible ()
void ensure_display_driver_if_needed ()

Protected Attributes

struct BlenderSession:: { ... }  draw_state_
BlenderDisplayDriver * display_driver_ = nullptr
vector< string > full_buffer_files_
int bake_id = 0

Detailed Description

Definition at line 37 of file blender/session.h.

Constructor & Destructor Documentation

◆ BlenderSession() [1/2]

BlenderSession::BlenderSession ( blender::RenderEngine & b_engine,
blender::UserDef & b_userpref,
blender::Main & b_data,
bool preview_osl )

◆ BlenderSession() [2/2]

BlenderSession::BlenderSession ( blender::RenderEngine & b_engine,
blender::UserDef & b_userpref,
blender::Main & b_data,
blender::bScreen * b_screen,
blender::View3D * b_v3d,
blender::RegionView3D * b_rv3d,
const int width,
int height )

◆ ~BlenderSession()

BlenderSession::~BlenderSession ( )

Definition at line 112 of file blender/session.cpp.

References free_session().

Member Function Documentation

◆ bake()

◆ builtin_images_load()

void BlenderSession::builtin_images_load ( )
protected

Definition at line 247 of file blender/image.cpp.

References ImageManager::device_load_builtin(), and session.

Referenced by bake(), render(), and synchronize().

◆ check_and_report_session_error()

bool BlenderSession::check_and_report_session_error ( )
protected

Definition at line 1050 of file blender/session.cpp.

References b_engine, last_error, and session.

Referenced by render_frame_finish(), and update_status_progress().

◆ create_session()

◆ draw()

◆ ensure_display_driver_if_needed()

void BlenderSession::ensure_display_driver_if_needed ( )
protected

◆ free_blender_memory_if_possible()

void BlenderSession::free_blender_memory_if_possible ( )
protected

Definition at line 1105 of file blender/session.cpp.

References b_engine, and background.

Referenced by render().

◆ free_session()

void BlenderSession::free_session ( )

Definition at line 255 of file blender/session.cpp.

References display_driver_, session, and sync.

Referenced by reset_session(), synchronize(), and ~BlenderSession().

◆ full_buffer_written()

void BlenderSession::full_buffer_written ( string_view filename)

Definition at line 267 of file blender/session.cpp.

References full_buffer_files_.

Referenced by bake(), and render().

◆ get_progress()

void BlenderSession::get_progress ( double & progress,
double & total_time,
double & render_time )

Definition at line 987 of file blender/session.cpp.

References session.

Referenced by update_status_progress().

◆ get_status()

void BlenderSession::get_status ( string & status,
string & substatus )

Definition at line 982 of file blender/session.cpp.

References session.

Referenced by update_status_progress().

◆ render()

◆ render_frame_finish()

◆ reset_session()

◆ stamp_view_layer_metadata()

void BlenderSession::stamp_view_layer_metadata ( Scene * scene,
const string & view_layer_name )
protected

◆ synchronize()

◆ tag_redraw()

void BlenderSession::tag_redraw ( )

◆ tag_update()

void BlenderSession::tag_update ( )

Definition at line 1070 of file blender/session.cpp.

References b_engine, blender::RenderEngine::flag, and blender::RE_ENGINE_DO_UPDATE.

Referenced by synchronize(), and view_draw().

◆ test_cancel()

void BlenderSession::test_cancel ( )

Definition at line 1095 of file blender/session.cpp.

References b_engine, background, and session.

Referenced by create_session().

◆ update_bake_progress()

void BlenderSession::update_bake_progress ( )

Definition at line 993 of file blender/session.cpp.

References b_engine, last_progress, and session.

Referenced by bake().

◆ update_status_progress()

◆ view_draw()

◆ view_pause()

void BlenderSession::view_pause ( const bool pause)

Definition at line 903 of file blender/session.cpp.

References session, and view_paused.

Referenced by view_pause_func().

Member Data Documentation

◆ b_data

blender::Main* BlenderSession::b_data

◆ b_depsgraph

blender::Depsgraph* BlenderSession::b_depsgraph

◆ b_engine

◆ b_render

◆ b_rlay_name

string BlenderSession::b_rlay_name

Definition at line 107 of file blender/session.h.

Referenced by draw(), render(), and render_frame_finish().

◆ b_rv3d

◆ b_rview_name

string BlenderSession::b_rview_name

Definition at line 108 of file blender/session.h.

Referenced by render(), and render_frame_finish().

◆ b_scene

◆ b_screen

blender::bScreen* BlenderSession::b_screen

◆ b_userpref

blender::UserDef& BlenderSession::b_userpref

◆ b_v3d

◆ background

◆ bake_id

int BlenderSession::bake_id = 0
protected

Definition at line 163 of file blender/session.h.

Referenced by bake().

◆ device_override

CCL_NAMESPACE_BEGIN DeviceTypeMask BlenderSession::device_override = DEVICE_MASK_ALL
static

Definition at line 125 of file blender/session.h.

Referenced by blender_device_info(), and set_device_override_func().

◆ display_driver_

BlenderDisplayDriver* BlenderSession::display_driver_ = nullptr
protected

◆ draw_state_

struct { ... } BlenderSession::draw_state_

Referenced by draw(), render(), and reset_session().

◆ full_buffer_files_

vector<string> BlenderSession::full_buffer_files_
protected

Definition at line 161 of file blender/session.h.

Referenced by full_buffer_written(), and render_frame_finish().

◆ headless

bool BlenderSession::headless = false
static

◆ height

int BlenderSession::height

◆ last_error

string BlenderSession::last_error

Definition at line 111 of file blender/session.h.

Referenced by check_and_report_session_error(), and create_session().

◆ last_progress

double BlenderSession::last_progress

Definition at line 112 of file blender/session.h.

Referenced by create_session(), update_bake_progress(), and update_status_progress().

◆ last_redraw_time

double BlenderSession::last_redraw_time

Definition at line 94 of file blender/session.h.

Referenced by BlenderSession(), BlenderSession(), and tag_redraw().

◆ last_status

string BlenderSession::last_status

Definition at line 110 of file blender/session.h.

Referenced by create_session(), and update_status_progress().

◆ last_status_time

double BlenderSession::last_status_time

Definition at line 113 of file blender/session.h.

Referenced by BlenderSession(), BlenderSession(), and update_status_progress().

◆ pixelsize

float BlenderSession::pixelsize

◆ preview_osl

bool BlenderSession::preview_osl

Definition at line 117 of file blender/session.h.

Referenced by BlenderSession(), BlenderSession(), and reset_session().

◆ print_render_stats

bool BlenderSession::print_render_stats = false
static

◆ scene

◆ session

◆ start_resize_time

double BlenderSession::start_resize_time

◆ sync

◆ use_developer_ui

bool BlenderSession::use_developer_ui

◆ view_paused

bool BlenderSession::view_paused = false

Definition at line 90 of file blender/session.h.

Referenced by create_session(), synchronize(), view_draw(), and view_pause().

◆ width

int BlenderSession::width

The documentation for this class was generated from the following files: