Blender V4.3
Classes | Macros | Typedefs | Enumerations | Functions
BKE_shader_fx.h File Reference
Blender » BlenKernel
#include "BLI_compiler_attrs.h"
#include "DNA_shader_fx_types.h"

Go to the source code of this file.

Classes

struct  ShaderFxTypeInfo
 

Macros

#define SHADER_FX_ACTIVE(_fx, _is_render)
 
#define SHADER_FX_EDIT(_fx, _is_edit)   ((((_fx)->mode & eShaderFxMode_Editmode) == 0) && (_is_edit))
 
#define SHADERFX_TYPE_PANEL_PREFIX   "FX_PT_"
 

Typedefs

typedef void(* ShaderFxIDWalkFunc) (void *user_data, struct Object *ob, struct ID **idpoin, int cb_flag)
 
typedef void(* ShaderFxTexWalkFunc) (void *user_data, struct Object *ob, struct ShaderFxData *fx, const char *propname)
 
typedef struct ShaderFxTypeInfo ShaderFxTypeInfo
 

Enumerations

enum  ShaderFxTypeType { eShaderFxType_NoneType , eShaderFxType_GpencilType }
 
enum  ShaderFxTypeFlag { eShaderFxTypeFlag_SupportsEditmode = (1 << 0) , eShaderFxTypeFlag_EnableInEditmode = (1 << 2) , eShaderFxTypeFlag_Single = (1 << 4) , eShaderFxTypeFlag_NoUserAdd = (1 << 5) }
 

Functions

void BKE_shaderfx_init (void)
 
void BKE_shaderfxType_panel_id (ShaderFxType type, char *r_idname)
 
void BKE_shaderfx_panel_expand (struct ShaderFxData *fx)
 
const ShaderFxTypeInfo * BKE_shaderfx_get_info (ShaderFxType type)
 
struct ShaderFxData * BKE_shaderfx_new (int type)
 
void BKE_shaderfx_free_ex (struct ShaderFxData *fx, int flag)
 
void BKE_shaderfx_free (struct ShaderFxData *fx)
 
void BKE_shaderfx_unique_name (struct ListBase *shaders, struct ShaderFxData *fx)
 
bool BKE_shaderfx_depends_ontime (struct ShaderFxData *fx)
 
bool BKE_shaderfx_is_nonlocal_in_liboverride (const struct Object *ob, const struct ShaderFxData *shaderfx)
 
struct ShaderFxData * BKE_shaderfx_findby_type (struct Object *ob, ShaderFxType type)
 
struct ShaderFxData * BKE_shaderfx_findby_name (struct Object *ob, const char *name)
 
void BKE_shaderfx_copydata_generic (const struct ShaderFxData *fx_src, struct ShaderFxData *fx_dst)
 
void BKE_shaderfx_copydata (struct ShaderFxData *fx, struct ShaderFxData *target)
 
void BKE_shaderfx_copydata_ex (struct ShaderFxData *fx, struct ShaderFxData *target, int flag)
 
void BKE_shaderfx_copy (struct ListBase *dst, const struct ListBase *src)
 
void BKE_shaderfx_foreach_ID_link (struct Object *ob, ShaderFxIDWalkFunc walk, void *user_data)
 
bool BKE_shaderfx_has_gpencil (const struct Object *ob)
 
void BKE_shaderfx_blend_write (struct BlendWriter *writer, struct ListBase *fxbase)
 
void BKE_shaderfx_blend_read_data (struct BlendDataReader *reader, struct ListBase *lb, struct Object *ob)
 

Macro Definition Documentation

◆ SHADER_FX_ACTIVE

#define SHADER_FX_ACTIVE ( _fx,
_is_render )
Value:
((((_fx)->mode & eShaderFxMode_Realtime) && (_is_render == false)) || \
(((_fx)->mode & eShaderFxMode_Render) && (_is_render == true)))
eShaderFxMode_Realtime
@ eShaderFxMode_Realtime
Definition DNA_shader_fx_types.h:37
eShaderFxMode_Render
@ eShaderFxMode_Render
Definition DNA_shader_fx_types.h:38

Definition at line 26 of file BKE_shader_fx.h.

◆ SHADER_FX_EDIT

#define SHADER_FX_EDIT ( _fx,
_is_edit )   ((((_fx)->mode & eShaderFxMode_Editmode) == 0) && (_is_edit))

Definition at line 29 of file BKE_shader_fx.h.

◆ SHADERFX_TYPE_PANEL_PREFIX

#define SHADERFX_TYPE_PANEL_PREFIX   "FX_PT_"

Definition at line 137 of file BKE_shader_fx.h.

Referenced by BKE_shaderfxType_panel_id().

Typedef Documentation

◆ ShaderFxIDWalkFunc

typedef void(* ShaderFxIDWalkFunc) (void *user_data, struct Object *ob, struct ID **idpoin, int cb_flag)

Definition at line 54 of file BKE_shader_fx.h.

◆ ShaderFxTexWalkFunc

typedef void(* ShaderFxTexWalkFunc) (void *user_data, struct Object *ob, struct ShaderFxData *fx, const char *propname)

Definition at line 58 of file BKE_shader_fx.h.

◆ ShaderFxTypeInfo

typedef struct ShaderFxTypeInfo ShaderFxTypeInfo

Enumeration Type Documentation

◆ ShaderFxTypeFlag

enum ShaderFxTypeFlag
Enumerator
eShaderFxTypeFlag_SupportsEditmode 
eShaderFxTypeFlag_EnableInEditmode 
eShaderFxTypeFlag_Single 
eShaderFxTypeFlag_NoUserAdd 

Definition at line 39 of file BKE_shader_fx.h.

◆ ShaderFxTypeType

enum ShaderFxTypeType
Enumerator
eShaderFxType_NoneType 
eShaderFxType_GpencilType 

Definition at line 31 of file BKE_shader_fx.h.

Function Documentation

◆ BKE_shaderfx_blend_read_data()

void BKE_shaderfx_blend_read_data ( struct BlendDataReader * reader,
struct ListBase * lb,
struct Object * ob )

Definition at line 275 of file shader_fx.cc.

References BKE_shaderfx_get_info(), BLO_read_struct_list, eShaderFxType_None, ID_IS_LINKED, and LISTBASE_FOREACH.

Referenced by object_blend_read_data().

◆ BKE_shaderfx_blend_write()

void BKE_shaderfx_blend_write ( struct BlendWriter * writer,
struct ListBase * fxbase )

Definition at line 259 of file shader_fx.cc.

References BKE_shaderfx_get_info(), BLO_write_struct_by_name(), LISTBASE_FOREACH, and ShaderFxTypeInfo::struct_name.

Referenced by object_blend_write().

◆ BKE_shaderfx_copy()

void BKE_shaderfx_copy ( struct ListBase * dst,
const struct ListBase * src )

Referenced by blender::ed::object::shaderfx_link().

◆ BKE_shaderfx_copydata()

void BKE_shaderfx_copydata ( struct ShaderFxData * fx,
struct ShaderFxData * target )

Definition at line 205 of file shader_fx.cc.

References BKE_shaderfx_copydata_ex().

Referenced by BKE_shaderfx_copy(), blender::ed::object::shaderfx_copy(), and blender::ed::object::shaderfx_copy_exec().

◆ BKE_shaderfx_copydata_ex()

void BKE_shaderfx_copydata_ex ( struct ShaderFxData * fx,
struct ShaderFxData * target,
int flag )

Definition at line 186 of file shader_fx.cc.

References BKE_shaderfx_get_info(), ShaderFxTypeInfo::copy_data, flag, ShaderFxData::flag, ShaderFxTypeInfo::foreach_ID_link, LIB_ID_CREATE_NO_USER_REFCOUNT, ShaderFxData::mode, shaderfx_copy_data_id_us_cb(), ShaderFxData::type, and ShaderFxData::ui_expand_flag.

Referenced by BKE_shaderfx_copydata(), and object_copy_data().

◆ BKE_shaderfx_copydata_generic()

void BKE_shaderfx_copydata_generic ( const struct ShaderFxData * fx_src,
struct ShaderFxData * fx_dst )

Referenced by copy_data(), copy_data(), copy_data(), copy_data(), copy_data(), copy_data(), copy_data(), copy_data(), and copy_data().

◆ BKE_shaderfx_depends_ontime()

bool BKE_shaderfx_depends_ontime ( struct ShaderFxData * fx)

Definition at line 124 of file shader_fx.cc.

References BKE_shaderfx_get_info(), ShaderFxTypeInfo::depends_on_time, and ShaderFxData::type.

Referenced by blender::deg::DepsgraphRelationBuilder::build_object_data_geometry().

◆ BKE_shaderfx_findby_name()

struct ShaderFxData * BKE_shaderfx_findby_name ( struct Object * ob,
const char * name )

Definition at line 253 of file shader_fx.cc.

References BLI_findstring(), offsetof, and Object::shader_fx.

Referenced by blender::ed::object::edit_shaderfx_property_get().

◆ BKE_shaderfx_findby_type()

struct ShaderFxData * BKE_shaderfx_findby_type ( struct Object * ob,
ShaderFxType type )

Definition at line 227 of file shader_fx.cc.

References ListBase::first, ShaderFxData::next, Object::shader_fx, and ShaderFxData::type.

Referenced by blender::ed::object::shaderfx_add().

◆ BKE_shaderfx_foreach_ID_link()

void BKE_shaderfx_foreach_ID_link ( struct Object * ob,
ShaderFxIDWalkFunc walk,
void * user_data )

Definition at line 240 of file shader_fx.cc.

References BKE_shaderfx_get_info(), ListBase::first, ShaderFxTypeInfo::foreach_ID_link, ShaderFxData::next, Object::shader_fx, and ShaderFxData::type.

Referenced by blender::deg::DepsgraphNodeBuilder::build_object(), blender::deg::DepsgraphRelationBuilder::build_object(), and object_foreach_id().

◆ BKE_shaderfx_free()

void BKE_shaderfx_free ( struct ShaderFxData * fx)

Definition at line 110 of file shader_fx.cc.

References BKE_shaderfx_free_ex().

Referenced by blender::ed::object::object_shaderfx_remove().

◆ BKE_shaderfx_free_ex()

void BKE_shaderfx_free_ex ( struct ShaderFxData * fx,
int flag )

Definition at line 90 of file shader_fx.cc.

References BKE_shaderfx_get_info(), ShaderFxData::error, flag, ShaderFxTypeInfo::foreach_ID_link, ShaderFxTypeInfo::free_data, LIB_ID_CREATE_NO_USER_REFCOUNT, MEM_freeN(), shaderfx_free_data_id_us_cb(), and ShaderFxData::type.

Referenced by BKE_object_free_shaderfx(), and BKE_shaderfx_free().

◆ BKE_shaderfx_get_info()

const ShaderFxTypeInfo * BKE_shaderfx_get_info ( ShaderFxType type)

Definition at line 131 of file shader_fx.cc.

References shader_fx_types.

Referenced by BKE_shaderfx_blend_read_data(), BKE_shaderfx_blend_write(), BKE_shaderfx_copydata_ex(), BKE_shaderfx_copydata_generic(), BKE_shaderfx_depends_ontime(), BKE_shaderfx_foreach_ID_link(), BKE_shaderfx_free_ex(), BKE_shaderfx_has_gpencil(), BKE_shaderfx_new(), BKE_shaderfx_unique_name(), BKE_shaderfxType_panel_id(), blender::deg::DepsgraphRelationBuilder::build_object_data_geometry(), ED_spacetype_buttons(), blender::ed::object::shaderfx_add(), blender::ed::object::shaderfx_add_itemf(), shaderfx_panel_header(), and uiTemplateShaderFx().

◆ BKE_shaderfx_has_gpencil()

bool BKE_shaderfx_has_gpencil ( const struct Object * ob)

Check if exist grease pencil effects.

◆ BKE_shaderfx_init()

void BKE_shaderfx_init ( void )

Initialize global data (type info and some common global storage).

Definition at line 48 of file shader_fx.cc.

References shader_fx_types, and shaderfx_type_init().

Referenced by main().

◆ BKE_shaderfx_is_nonlocal_in_liboverride()

bool BKE_shaderfx_is_nonlocal_in_liboverride ( const struct Object * ob,
const struct ShaderFxData * shaderfx )

Check whether given shaderfx is not local (i.e. from linked data) when the object is a library override.

Parameters
shaderfxMay be NULL, in which case we consider it as a non-local shaderfx case.

Referenced by blender::ed::object::edit_shaderfx_poll_generic().

◆ BKE_shaderfx_new()

struct ShaderFxData * BKE_shaderfx_new ( int type)

Definition at line 54 of file shader_fx.cc.

References BKE_shaderfx_get_info(), DATA_, eShaderFxFlag_OverrideLibrary_Local, eShaderFxMode_Editmode, eShaderFxMode_Realtime, eShaderFxMode_Render, eShaderFxTypeFlag_EnableInEditmode, ShaderFxData::flag, ShaderFxTypeInfo::flags, ShaderFxTypeInfo::init_data, MEM_callocN, ShaderFxData::mode, ShaderFxData::name, ShaderFxTypeInfo::name, STRNCPY_UTF8, ShaderFxTypeInfo::struct_name, ShaderFxTypeInfo::struct_size, ShaderFxData::type, ShaderFxData::ui_expand_flag, and UI_PANEL_DATA_EXPAND_ROOT.

Referenced by object_copy_data(), blender::ed::object::shaderfx_add(), blender::ed::object::shaderfx_copy(), and blender::ed::object::shaderfx_copy_exec().

◆ BKE_shaderfx_panel_expand()

void BKE_shaderfx_panel_expand ( struct ShaderFxData * fx)

Definition at line 153 of file shader_fx.cc.

References ShaderFxData::ui_expand_flag, and UI_PANEL_DATA_EXPAND_ROOT.

Referenced by blender::ed::outliner::outliner_set_properties_tab().

◆ BKE_shaderfx_unique_name()

void BKE_shaderfx_unique_name ( struct ListBase * shaders,
struct ShaderFxData * fx )

Check unique name.

Definition at line 115 of file shader_fx.cc.

References BKE_shaderfx_get_info(), BLI_uniquename(), DATA_, ShaderFxData::name, ShaderFxTypeInfo::name, offsetof, and ShaderFxData::type.

Referenced by blender::ed::object::shaderfx_add(), and blender::ed::object::shaderfx_copy_exec().

◆ BKE_shaderfxType_panel_id()

void BKE_shaderfxType_panel_id ( ShaderFxType type,
char * r_idname )

Get an effect's panel type, which was defined in the panel_register callback.

Note
ShaderFx panel types are assumed to be named with the struct name field concatenated to the defined prefix.

Definition at line 147 of file shader_fx.cc.

References BKE_shaderfx_get_info(), BKE_ST_MAXNAME, BLI_string_join, ShaderFxTypeInfo::name, and SHADERFX_TYPE_PANEL_PREFIX.

Referenced by shaderfx_panel_id(), and shaderfx_panel_register().

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0