Blender V4.5
Classes | Macros | Typedefs | Enumerations | Functions
BKE_studiolight.h File Reference
Blender » BlenKernel
#include "BLI_sys_types.h"
#include "BLI_path_utils.hh"
#include "DNA_userdef_types.h"

Go to the source code of this file.

Classes

struct  StudioLightImage
struct  StudioLight

Macros

#define STUDIOLIGHT_ICON_ID_TYPE_RADIANCE   (1 << 0)
#define STUDIOLIGHT_ICON_ID_TYPE_IRRADIANCE   (1 << 1)
#define STUDIOLIGHT_ICON_ID_TYPE_MATCAP   (1 << 2)
#define STUDIOLIGHT_ICON_ID_TYPE_MATCAP_FLIPPED   (1 << 3)
#define STUDIOLIGHT_MAX_LIGHT   4
#define STUDIOLIGHT_ICON_SIZE   96
#define STUDIOLIGHT_FLAG_ALL   (STUDIOLIGHT_INTERNAL | STUDIOLIGHT_EXTERNAL_FILE)
#define STUDIOLIGHT_FLAG_ORIENTATIONS   (STUDIOLIGHT_TYPE_STUDIO | STUDIOLIGHT_TYPE_WORLD | STUDIOLIGHT_TYPE_MATCAP)
#define STUDIOLIGHT_ORIENTATIONS_MATERIAL_MODE   (STUDIOLIGHT_TYPE_WORLD)
#define STUDIOLIGHT_ORIENTATIONS_SOLID   (STUDIOLIGHT_INTERNAL | STUDIOLIGHT_TYPE_STUDIO)

Typedefs

typedef void StudioLightFreeFunction(struct StudioLight *, void *data)
typedef struct StudioLightImage StudioLightImage
typedef struct StudioLight StudioLight

Enumerations

enum  StudioLightFlag {
  STUDIOLIGHT_INTERNAL = (1 << 0) , STUDIOLIGHT_EXTERNAL_FILE = (1 << 1) , STUDIOLIGHT_TYPE_STUDIO = (1 << 2) , STUDIOLIGHT_TYPE_WORLD = (1 << 3) ,
  STUDIOLIGHT_TYPE_MATCAP = (1 << 4) , STUDIOLIGHT_EXTERNAL_IMAGE_LOADED = (1 << 5) , STUDIOLIGHT_EQUIRECT_RADIANCE_GPUTEXTURE = (1 << 6) , STUDIOLIGHT_USER_DEFINED = (1 << 7) ,
  STUDIOLIGHT_MATCAP_DIFFUSE_GPUTEXTURE = (1 << 8) , STUDIOLIGHT_MATCAP_SPECULAR_GPUTEXTURE = (1 << 9) , STUDIOLIGHT_SPECULAR_HIGHLIGHT_PASS = (1 << 10)
}

Functions

void BKE_studiolight_init (void)
void BKE_studiolight_free (void)
void BKE_studiolight_default (SolidLight lights[4], float light_ambient[3])
struct StudioLight * BKE_studiolight_find (const char *name, int flag)
struct StudioLight * BKE_studiolight_findindex (int index, int flag)
struct StudioLight * BKE_studiolight_find_default (int flag)
void BKE_studiolight_preview (uint *icon_buffer, StudioLight *sl, int icon_id_type)
struct ListBase * BKE_studiolight_listbase (void)
void BKE_studiolight_ensure_flag (StudioLight *sl, int flag)
void BKE_studiolight_refresh (void)
StudioLight * BKE_studiolight_load (const char *filepath, int type)
StudioLight * BKE_studiolight_create (const char *filepath, const SolidLight light[4], const float light_ambient[3])
StudioLight * BKE_studiolight_studio_edit_get (void)
void BKE_studiolight_remove (StudioLight *sl)
void BKE_studiolight_set_free_function (StudioLight *sl, StudioLightFreeFunction *free_function, void *data)
void BKE_studiolight_unset_icon_id (StudioLight *sl, int icon_id)

Detailed Description

Studio lighting for the 3dview

Definition in file BKE_studiolight.h.

Macro Definition Documentation

◆ STUDIOLIGHT_FLAG_ALL

#define STUDIOLIGHT_FLAG_ALL   (STUDIOLIGHT_INTERNAL | STUDIOLIGHT_EXTERNAL_FILE)

Definition at line 51 of file BKE_studiolight.h.

◆ STUDIOLIGHT_FLAG_ORIENTATIONS

#define STUDIOLIGHT_FLAG_ORIENTATIONS   (STUDIOLIGHT_TYPE_STUDIO | STUDIOLIGHT_TYPE_WORLD | STUDIOLIGHT_TYPE_MATCAP)

Definition at line 52 of file BKE_studiolight.h.

Referenced by UI_icon_from_rnaptr().

◆ STUDIOLIGHT_ICON_ID_TYPE_IRRADIANCE

#define STUDIOLIGHT_ICON_ID_TYPE_IRRADIANCE   (1 << 1)

Definition at line 22 of file BKE_studiolight.h.

Referenced by BKE_studiolight_preview(), and studiolight_create().

◆ STUDIOLIGHT_ICON_ID_TYPE_MATCAP

#define STUDIOLIGHT_ICON_ID_TYPE_MATCAP   (1 << 2)

Definition at line 23 of file BKE_studiolight.h.

Referenced by BKE_studiolight_preview(), and studiolight_create().

◆ STUDIOLIGHT_ICON_ID_TYPE_MATCAP_FLIPPED

#define STUDIOLIGHT_ICON_ID_TYPE_MATCAP_FLIPPED   (1 << 3)

Definition at line 24 of file BKE_studiolight.h.

Referenced by BKE_studiolight_preview(), and studiolight_create().

◆ STUDIOLIGHT_ICON_ID_TYPE_RADIANCE

#define STUDIOLIGHT_ICON_ID_TYPE_RADIANCE   (1 << 0)

Definition at line 21 of file BKE_studiolight.h.

Referenced by BKE_studiolight_preview(), and studiolight_create().

◆ STUDIOLIGHT_ICON_SIZE

#define STUDIOLIGHT_ICON_SIZE   96

Definition at line 28 of file BKE_studiolight.h.

Referenced by studiolight_irradiance_preview(), studiolight_matcap_preview(), studiolight_radiance_preview(), and ui_icon_ensure_deferred().

◆ STUDIOLIGHT_MAX_LIGHT

#define STUDIOLIGHT_MAX_LIGHT   4

Definition at line 26 of file BKE_studiolight.h.

Referenced by studiolight_lights_eval().

◆ STUDIOLIGHT_ORIENTATIONS_MATERIAL_MODE

#define STUDIOLIGHT_ORIENTATIONS_MATERIAL_MODE   (STUDIOLIGHT_TYPE_WORLD)

Definition at line 54 of file BKE_studiolight.h.

Referenced by blender::io::hydra::WorldData::init(), and blender::eevee::LookdevWorld::sync().

◆ STUDIOLIGHT_ORIENTATIONS_SOLID

#define STUDIOLIGHT_ORIENTATIONS_SOLID   (STUDIOLIGHT_INTERNAL | STUDIOLIGHT_TYPE_STUDIO)

Definition at line 55 of file BKE_studiolight.h.

Typedef Documentation

◆ StudioLight

typedef struct StudioLight StudioLight

◆ StudioLightFreeFunction

typedef void StudioLightFreeFunction(struct StudioLight *, void *data)

Definition at line 57 of file BKE_studiolight.h.

◆ StudioLightImage

typedef struct StudioLightImage StudioLightImage

Enumeration Type Documentation

◆ StudioLightFlag

enum StudioLightFlag

StudioLight.flag

Enumerator
STUDIOLIGHT_INTERNAL 
STUDIOLIGHT_EXTERNAL_FILE 
STUDIOLIGHT_TYPE_STUDIO 
STUDIOLIGHT_TYPE_WORLD 
STUDIOLIGHT_TYPE_MATCAP 
STUDIOLIGHT_EXTERNAL_IMAGE_LOADED 
STUDIOLIGHT_EQUIRECT_RADIANCE_GPUTEXTURE 

GPU Texture used for lookdev mode.

STUDIOLIGHT_USER_DEFINED 
STUDIOLIGHT_MATCAP_DIFFUSE_GPUTEXTURE 
STUDIOLIGHT_MATCAP_SPECULAR_GPUTEXTURE 
STUDIOLIGHT_SPECULAR_HIGHLIGHT_PASS 

Definition at line 34 of file BKE_studiolight.h.

Function Documentation

◆ BKE_studiolight_create()

StudioLight * BKE_studiolight_create ( const char * filepath,
const SolidLight light[4],
const float light_ambient[3] )

Definition at line 1000 of file studiolight.cc.

References BKE_studiolight_create(), BLI_addtail(), BLI_path_split_file_part(), FILE_MAXFILE, StudioLight::filepath, StudioLight::light, StudioLight::light_ambient, StudioLight::name, STRNCPY(), studiolight_create(), STUDIOLIGHT_EXTERNAL_FILE, STUDIOLIGHT_SPECULAR_HIGHLIGHT_PASS, STUDIOLIGHT_TYPE_STUDIO, STUDIOLIGHT_USER_DEFINED, studiolight_write_solid_light(), and studiolights.

Referenced by BKE_studiolight_create().

◆ BKE_studiolight_default()

void BKE_studiolight_default ( SolidLight lights[4],
float light_ambient[3] )

Definition at line 785 of file studiolight.cc.

References BKE_studiolight_default(), SolidLight::col, copy_v3_fl3(), SolidLight::flag, SolidLight::smooth, SolidLight::spec, and SolidLight::vec.

Referenced by BKE_blendfile_userdef_from_defaults(), BKE_studiolight_default(), and BKE_studiolight_init().

◆ BKE_studiolight_ensure_flag()

void BKE_studiolight_ensure_flag ( StudioLight * sl,
int flag )

Ensure state of studio-lights.

Definition at line 962 of file studiolight.cc.

References BKE_studiolight_ensure_flag(), StudioLight::flag, studiolight_create_equirect_radiance_gputexture(), studiolight_create_matcap_diffuse_gputexture(), studiolight_create_matcap_specular_gputexture(), STUDIOLIGHT_EQUIRECT_RADIANCE_GPUTEXTURE, STUDIOLIGHT_EXTERNAL_IMAGE_LOADED, studiolight_load_equirect_image(), STUDIOLIGHT_MATCAP_DIFFUSE_GPUTEXTURE, and STUDIOLIGHT_MATCAP_SPECULAR_GPUTEXTURE.

Referenced by BKE_studiolight_ensure_flag(), blender::workbench::get_matcap_tx(), studiolight_create_equirect_radiance_gputexture(), studiolight_create_matcap_diffuse_gputexture(), studiolight_create_matcap_specular_gputexture(), studiolight_matcap_preview(), studiolight_radiance_preview(), and blender::eevee::LookdevWorld::sync().

◆ BKE_studiolight_find()

struct StudioLight * BKE_studiolight_find ( const char * name,
int flag )

Definition at line 906 of file studiolight.cc.

References BKE_studiolight_find(), BKE_studiolight_find_default(), FILE_MAXFILE, LISTBASE_FOREACH, STREQLEN, and studiolights.

Referenced by BKE_studiolight_find(), blo_do_versions_280(), blender::io::hydra::WorldData::init(), blender::workbench::SceneResources::init(), and blender::eevee::LookdevWorld::sync().

◆ BKE_studiolight_find_default()

struct StudioLight * BKE_studiolight_find_default ( int flag)

Definition at line 881 of file studiolight.cc.

References BKE_studiolight_find_default(), LISTBASE_FOREACH, STREQ, STUDIOLIGHT_MATCAP_DEFAULT, STUDIOLIGHT_TYPE_MATCAP, STUDIOLIGHT_TYPE_WORLD, STUDIOLIGHT_WORLD_DEFAULT, and studiolights.

Referenced by BKE_studiolight_find(), BKE_studiolight_find_default(), BKE_studiolight_findindex(), and blo_do_versions_280().

◆ BKE_studiolight_findindex()

struct StudioLight * BKE_studiolight_findindex ( int index,
int flag )

Definition at line 922 of file studiolight.cc.

References BKE_studiolight_find_default(), BKE_studiolight_findindex(), LISTBASE_FOREACH, and studiolights.

Referenced by BKE_studiolight_findindex().

◆ BKE_studiolight_free()

void BKE_studiolight_free ( void )

Definition at line 874 of file studiolight.cc.

References BKE_studiolight_free(), BLI_pophead(), studiolight_free(), and studiolights.

Referenced by BKE_blender_free(), BKE_studiolight_free(), and BKE_studiolight_refresh().

◆ BKE_studiolight_init()

void BKE_studiolight_init ( void )

Definition at line 838 of file studiolight.cc.

References BKE_studiolight_default(), BKE_studiolight_init(), BLENDER_SYSTEM_DATAFILES, BLENDER_USER_DATAFILES, BLI_addtail(), BLI_listbase_sort(), StudioLight::light, StudioLight::light_ambient, StudioLight::name, STRNCPY(), studiolight_add_files_from_datafolder(), studiolight_cmp(), studiolight_create(), STUDIOLIGHT_INTERNAL, STUDIOLIGHT_LIGHTS_FOLDER, STUDIOLIGHT_MATCAP_FOLDER, STUDIOLIGHT_SPECULAR_HIGHLIGHT_PASS, STUDIOLIGHT_TYPE_MATCAP, STUDIOLIGHT_TYPE_STUDIO, STUDIOLIGHT_TYPE_WORLD, STUDIOLIGHT_USER_DEFINED, STUDIOLIGHT_WORLD_FOLDER, and studiolights.

Referenced by BKE_studiolight_init(), BKE_studiolight_refresh(), and WM_init().

◆ BKE_studiolight_listbase()

struct ListBase * BKE_studiolight_listbase ( void )

Definition at line 933 of file studiolight.cc.

References BKE_studiolight_listbase(), and studiolights.

Referenced by BKE_studiolight_listbase().

◆ BKE_studiolight_load()

StudioLight * BKE_studiolight_load ( const char * filepath,
int type )

Definition at line 994 of file studiolight.cc.

References BKE_studiolight_load(), studiolight_add_file(), and STUDIOLIGHT_USER_DEFINED.

Referenced by BKE_studiolight_load().

◆ BKE_studiolight_preview()

void BKE_studiolight_preview ( uint * icon_buffer,
StudioLight * sl,
int icon_id_type )

Definition at line 938 of file studiolight.cc.

References BKE_studiolight_preview(), studiolight_free_temp_resources(), STUDIOLIGHT_ICON_ID_TYPE_IRRADIANCE, STUDIOLIGHT_ICON_ID_TYPE_MATCAP, STUDIOLIGHT_ICON_ID_TYPE_MATCAP_FLIPPED, STUDIOLIGHT_ICON_ID_TYPE_RADIANCE, studiolight_irradiance_preview(), studiolight_matcap_preview(), and studiolight_radiance_preview().

Referenced by BKE_studiolight_preview(), and ui_studiolight_icon_job_exec().

◆ BKE_studiolight_refresh()

void BKE_studiolight_refresh ( void )

Definition at line 1033 of file studiolight.cc.

References BKE_studiolight_free(), BKE_studiolight_init(), and BKE_studiolight_refresh().

Referenced by BKE_studiolight_refresh().

◆ BKE_studiolight_remove()

void BKE_studiolight_remove ( StudioLight * sl)

Definition at line 986 of file studiolight.cc.

References BKE_studiolight_remove(), BLI_remlink(), StudioLight::flag, studiolight_free(), STUDIOLIGHT_USER_DEFINED, and studiolights.

Referenced by BKE_studiolight_remove().

◆ BKE_studiolight_set_free_function()

void BKE_studiolight_set_free_function ( StudioLight * sl,
StudioLightFreeFunction * free_function,
void * data )

Definition at line 1039 of file studiolight.cc.

References BKE_studiolight_set_free_function(), data, StudioLight::free_function, and StudioLight::free_function_data.

Referenced by BKE_studiolight_set_free_function(), ui_icon_ensure_deferred(), and ui_studiolight_icon_job_end().

◆ BKE_studiolight_studio_edit_get()

StudioLight * BKE_studiolight_studio_edit_get ( void )

Only useful for workbench while editing the user-preferences.

Definition at line 1022 of file studiolight.cc.

References BKE_studiolight_studio_edit_get(), StudioLight::flag, StudioLight::light, StudioLight::light_ambient, STUDIOLIGHT_SPECULAR_HIGHLIGHT_PASS, STUDIOLIGHT_TYPE_STUDIO, and U.

Referenced by BKE_studiolight_studio_edit_get(), and blender::workbench::SceneResources::init().

◆ BKE_studiolight_unset_icon_id()

void BKE_studiolight_unset_icon_id ( StudioLight * sl,
int icon_id )

Definition at line 1047 of file studiolight.cc.

References BKE_studiolight_unset_icon_id(), BLI_assert, StudioLight::icon_id_irradiance, StudioLight::icon_id_matcap, StudioLight::icon_id_matcap_flipped, and StudioLight::icon_id_radiance.

Referenced by BKE_studiolight_unset_icon_id(), and icon_free_data().

Generated on for Blender by  doxygen 1.18.0