#include <overlay_private.hh>

Public Member Functions
View::OffsetData	offset_data_get () const
bool	is_solid () const
bool	is_xray () const
bool	is_wire () const
bool	is_space_v3d () const
bool	is_space_image () const
bool	is_space_node () const
bool	show_extras () const
bool	show_face_orientation () const
bool	show_bone_selection () const
bool	show_wireframes () const
bool	show_motion_paths () const
bool	show_bones () const
bool	show_object_origins () const
bool	show_fade_inactive () const
bool	show_attribute_viewer () const
bool	show_attribute_viewer_text () const
bool	show_sculpt_mask () const
bool	show_sculpt_face_sets () const
bool	show_sculpt_curves_cage () const
bool	show_light_colors () const

Public Attributes
Depsgraph *	depsgraph = nullptr
const ViewLayer *	view_layer = nullptr
const Scene *	scene = nullptr
const View3D *	v3d = nullptr
const SpaceLink *	space_data = nullptr
const ARegion *	region = nullptr
const RegionView3D *	rv3d = nullptr
DRWTextStore *	dt = nullptr
View3DOverlay	overlay = {}
eSpace_Type	space_type = SPACE_EMPTY
eContextObjectMode	ctx_mode = CTX_MODE_EDIT_MESH
eObjectMode	object_mode = OB_MODE_OBJECT
const Object *	object_active = nullptr
bool	clear_in_front = false
bool	use_in_front = false
bool	is_wireframe_mode = false
bool	is_viewport_image_render = false
bool	is_image_render = false
bool	is_depth_only_drawing = false
bool	skip_particles = false
bool	is_material_select = false
bool	draw_background = false
bool	is_render_depth_available = false
bool	vignette_enabled = false
bool	show_text = false
bool	hide_overlays = false
bool	xray_enabled = false
bool	xray_enabled_and_not_wire = false
bool	xray_flag_enabled = false
bool	do_pose_xray = false
bool	do_pose_fade_geom = false
float	xray_opacity = 0.0f
short	v3d_flag = 0
short	v3d_gridflag = 0
int	cfra = 0
float3	camera_position = float3(0.0f)
float3	camera_forward = float3(0.0f)
int	clipping_plane_count = 0
bool	is_image_valid = false
int2	image_size = int2(0)
float2	image_uv_aspect = float2(0.0f)
float2	image_aspect = float2(0.0f)
float	ndc_offset_factor = 0.0f

Detailed Description

Definition at line 125 of file overlay_private.hh.

Member Function Documentation

◆ is_solid()

bool blender::draw::overlay::State::is_solid ( ) const

inline

Convenience functions. Scene geometry is solid. Occlude overlays behind scene geometry.

Definition at line 199 of file overlay_private.hh.

References xray_opacity.

◆ is_space_image()

bool blender::draw::overlay::State::is_space_image ( ) const

inline

Definition at line 218 of file overlay_private.hh.

References SPACE_IMAGE.

◆ is_space_node()

bool blender::draw::overlay::State::is_space_node ( ) const

inline

Definition at line 222 of file overlay_private.hh.

References SPACE_NODE.

◆ is_space_v3d()

bool blender::draw::overlay::State::is_space_v3d ( ) const

inline

Definition at line 214 of file overlay_private.hh.

References SPACE_VIEW3D.

◆ is_wire()

bool blender::draw::overlay::State::is_wire ( ) const

inline

Scene geometry is fully transparent. Scene geometry does not occlude overlays.

Definition at line 209 of file overlay_private.hh.

References xray_opacity.

◆ is_xray()

bool blender::draw::overlay::State::is_xray ( ) const

inline

Scene geometry is semi-transparent. Fade overlays behind scene geometry (see XrayFade).

Definition at line 204 of file overlay_private.hh.

References xray_opacity.

◆ offset_data_get()

View::OffsetData blender::draw::overlay::State::offset_data_get ( ) const

inline

Definition at line 183 of file overlay_private.hh.

References rv3d.

◆ show_attribute_viewer()

bool blender::draw::overlay::State::show_attribute_viewer ( ) const

inline

Definition at line 259 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_VIEWER_ATTRIBUTE.

◆ show_attribute_viewer_text()

bool blender::draw::overlay::State::show_attribute_viewer_text ( ) const

inline

Definition at line 263 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_VIEWER_ATTRIBUTE_TEXT.

◆ show_bone_selection()

bool blender::draw::overlay::State::show_bone_selection ( ) const

inline

Definition at line 235 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_BONE_SELECT.

◆ show_bones()

bool blender::draw::overlay::State::show_bones ( ) const

inline

Definition at line 247 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_HIDE_BONES.

◆ show_extras()

bool blender::draw::overlay::State::show_extras ( ) const

inline

Definition at line 227 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_HIDE_OBJECT_XTRAS.

◆ show_face_orientation()

bool blender::draw::overlay::State::show_face_orientation ( ) const

inline

Definition at line 231 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_FACE_ORIENTATION.

◆ show_fade_inactive()

bool blender::draw::overlay::State::show_fade_inactive ( ) const

inline

Definition at line 255 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_FADE_INACTIVE.

◆ show_light_colors()

bool blender::draw::overlay::State::show_light_colors ( ) const

inline

Definition at line 279 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_SHOW_LIGHT_COLORS.

◆ show_motion_paths()

bool blender::draw::overlay::State::show_motion_paths ( ) const

inline

Definition at line 243 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_HIDE_MOTION_PATHS.

◆ show_object_origins()

bool blender::draw::overlay::State::show_object_origins ( ) const

inline

Definition at line 251 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_HIDE_OBJECT_ORIGINS.

◆ show_sculpt_curves_cage()

bool blender::draw::overlay::State::show_sculpt_curves_cage ( ) const

inline

Definition at line 275 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_SCULPT_CURVES_CAGE.

◆ show_sculpt_face_sets()

bool blender::draw::overlay::State::show_sculpt_face_sets ( ) const

inline

Definition at line 271 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_SCULPT_SHOW_FACE_SETS.

◆ show_sculpt_mask()

bool blender::draw::overlay::State::show_sculpt_mask ( ) const

inline

Definition at line 267 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_SCULPT_SHOW_MASK.

◆ show_wireframes()

bool blender::draw::overlay::State::show_wireframes ( ) const

inline

Definition at line 239 of file overlay_private.hh.

References View3DOverlay::flag, and V3D_OVERLAY_WIREFRAMES.

Member Data Documentation

◆ camera_forward

float3 blender::draw::overlay::State::camera_forward = float3(0.0f)

Definition at line 174 of file overlay_private.hh.

◆ camera_position

float3 blender::draw::overlay::State::camera_position = float3(0.0f)

Definition at line 173 of file overlay_private.hh.

◆ cfra

int blender::draw::overlay::State::cfra = 0

Definition at line 172 of file overlay_private.hh.

◆ clear_in_front

bool blender::draw::overlay::State::clear_in_front = false

Definition at line 139 of file overlay_private.hh.

◆ clipping_plane_count

int blender::draw::overlay::State::clipping_plane_count = 0

Definition at line 175 of file overlay_private.hh.

◆ ctx_mode

eContextObjectMode blender::draw::overlay::State::ctx_mode = CTX_MODE_EDIT_MESH

Definition at line 136 of file overlay_private.hh.

◆ depsgraph

Depsgraph* blender::draw::overlay::State::depsgraph = nullptr

Definition at line 126 of file overlay_private.hh.

◆ do_pose_fade_geom

bool blender::draw::overlay::State::do_pose_fade_geom = false

Add a veil on top of all surfaces to make the active pose armature pop out.

Definition at line 168 of file overlay_private.hh.

◆ do_pose_xray

bool blender::draw::overlay::State::do_pose_xray = false

Brings the active pose armature in front of all objects.

Definition at line 166 of file overlay_private.hh.

◆ draw_background

bool blender::draw::overlay::State::draw_background = false

Whether we should render the background or leave it transparent.

Definition at line 153 of file overlay_private.hh.

◆ dt

DRWTextStore* blender::draw::overlay::State::dt = nullptr

Definition at line 133 of file overlay_private.hh.

◆ hide_overlays

bool blender::draw::overlay::State::hide_overlays = false

Definition at line 160 of file overlay_private.hh.

◆ image_aspect

float2 blender::draw::overlay::State::image_aspect = float2(0.0f)

Definition at line 181 of file overlay_private.hh.

◆ image_size

int2 blender::draw::overlay::State::image_size = int2(0)

Definition at line 179 of file overlay_private.hh.

◆ image_uv_aspect

float2 blender::draw::overlay::State::image_uv_aspect = float2(0.0f)

Definition at line 180 of file overlay_private.hh.

◆ is_depth_only_drawing

bool blender::draw::overlay::State::is_depth_only_drawing = false

True if rendering only to query the depth. Can be for auto-depth rotation.

Definition at line 147 of file overlay_private.hh.

◆ is_image_render

bool blender::draw::overlay::State::is_image_render = false

Whether we are rendering for an image.

Definition at line 145 of file overlay_private.hh.

◆ is_image_valid

bool blender::draw::overlay::State::is_image_valid = false

Active Image properties. Only valid image space only.

Definition at line 178 of file overlay_private.hh.

◆ is_material_select

bool blender::draw::overlay::State::is_material_select = false

When drag-dropping material onto objects to assignment.

Definition at line 151 of file overlay_private.hh.

◆ is_render_depth_available

bool blender::draw::overlay::State::is_render_depth_available = false

True if the render engine outputs satisfactory depth information to the depth buffer.

Definition at line 155 of file overlay_private.hh.

◆ is_viewport_image_render

bool blender::draw::overlay::State::is_viewport_image_render = false

Whether we are rendering for an image (viewport render).

Definition at line 143 of file overlay_private.hh.

◆ is_wireframe_mode

bool blender::draw::overlay::State::is_wireframe_mode = false

Definition at line 141 of file overlay_private.hh.

◆ ndc_offset_factor

float blender::draw::overlay::State::ndc_offset_factor = 0.0f

Definition at line 194 of file overlay_private.hh.

◆ object_active

const Object* blender::draw::overlay::State::object_active = nullptr

Definition at line 138 of file overlay_private.hh.

◆ object_mode

eObjectMode blender::draw::overlay::State::object_mode = OB_MODE_OBJECT

Definition at line 137 of file overlay_private.hh.

◆ overlay

View3DOverlay blender::draw::overlay::State::overlay = {}

Definition at line 134 of file overlay_private.hh.

◆ region

const ARegion* blender::draw::overlay::State::region = nullptr

Definition at line 131 of file overlay_private.hh.

◆ rv3d

const RegionView3D* blender::draw::overlay::State::rv3d = nullptr

Definition at line 132 of file overlay_private.hh.

Referenced by offset_data_get().

◆ scene

const Scene* blender::draw::overlay::State::scene = nullptr

Definition at line 128 of file overlay_private.hh.

◆ show_text

bool blender::draw::overlay::State::show_text = false

Should text draw in this mode?

Definition at line 159 of file overlay_private.hh.

◆ skip_particles

bool blender::draw::overlay::State::skip_particles = false

Skip drawing particle systems. Prevents self-occlusion issues in Particle Edit mode.

Definition at line 149 of file overlay_private.hh.

◆ space_data

const SpaceLink* blender::draw::overlay::State::space_data = nullptr

Definition at line 130 of file overlay_private.hh.

◆ space_type

eSpace_Type blender::draw::overlay::State::space_type = SPACE_EMPTY

Definition at line 135 of file overlay_private.hh.

◆ use_in_front

bool blender::draw::overlay::State::use_in_front = false

Definition at line 140 of file overlay_private.hh.

◆ v3d

const View3D* blender::draw::overlay::State::v3d = nullptr

Definition at line 129 of file overlay_private.hh.

◆ v3d_flag

short blender::draw::overlay::State::v3d_flag = 0

Definition at line 170 of file overlay_private.hh.

◆ v3d_gridflag

short blender::draw::overlay::State::v3d_gridflag = 0

Definition at line 171 of file overlay_private.hh.

◆ view_layer

const ViewLayer* blender::draw::overlay::State::view_layer = nullptr

Definition at line 127 of file overlay_private.hh.

◆ vignette_enabled

bool blender::draw::overlay::State::vignette_enabled = false

Whether we should render a vignette over the scene.

Definition at line 157 of file overlay_private.hh.

◆ xray_enabled

bool blender::draw::overlay::State::xray_enabled = false

Definition at line 161 of file overlay_private.hh.

◆ xray_enabled_and_not_wire

bool blender::draw::overlay::State::xray_enabled_and_not_wire = false

Definition at line 162 of file overlay_private.hh.

◆ xray_flag_enabled

bool blender::draw::overlay::State::xray_flag_enabled = false

Can be true even if X-ray Alpha is 1.0.

Definition at line 164 of file overlay_private.hh.

◆ xray_opacity

float blender::draw::overlay::State::xray_opacity = 0.0f

Definition at line 169 of file overlay_private.hh.

Referenced by is_solid(), is_wire(), and is_xray().

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

overlay_private.hh

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ is_solid()

◆ is_space_image()

◆ is_space_node()

◆ is_space_v3d()

◆ is_wire()

◆ is_xray()

◆ offset_data_get()

◆ show_attribute_viewer()

◆ show_attribute_viewer_text()

◆ show_bone_selection()

◆ show_bones()

◆ show_extras()

◆ show_face_orientation()

◆ show_fade_inactive()

◆ show_light_colors()

◆ show_motion_paths()

◆ show_object_origins()

◆ show_sculpt_curves_cage()

◆ show_sculpt_face_sets()

◆ show_sculpt_mask()

◆ show_wireframes()

Member Data Documentation

◆ camera_forward

◆ camera_position

◆ cfra

◆ clear_in_front

◆ clipping_plane_count

◆ ctx_mode

◆ depsgraph

◆ do_pose_fade_geom

◆ do_pose_xray

◆ draw_background

◆ dt

◆ hide_overlays

◆ image_aspect

◆ image_size

◆ image_uv_aspect

◆ is_depth_only_drawing

◆ is_image_render

◆ is_image_valid

◆ is_material_select

◆ is_render_depth_available

◆ is_viewport_image_render

◆ is_wireframe_mode

◆ ndc_offset_factor

◆ object_active

◆ object_mode

◆ overlay

◆ region

◆ rv3d

◆ scene

◆ show_text

◆ skip_particles

◆ space_data

◆ space_type

◆ use_in_front

◆ v3d

◆ v3d_flag

◆ v3d_gridflag

◆ view_layer

◆ vignette_enabled

◆ xray_enabled

◆ xray_enabled_and_not_wire

◆ xray_flag_enabled

◆ xray_opacity