gpu_viewport.cc File Reference

#include <cstring>
#include "BLI_math_vector.h"
#include "BLI_math_vector_types.hh"
#include "BLI_rect.h"
#include "BKE_colortools.hh"
#include "IMB_colormanagement.hh"
#include "DNA_vec_types.h"
#include "GPU_capabilities.hh"
#include "GPU_framebuffer.hh"
#include "GPU_immediate.hh"
#include "GPU_matrix.hh"
#include "GPU_state.hh"
#include "GPU_texture.hh"
#include "GPU_viewport.hh"
#include "DRW_engine.hh"
#include "MEM_guardedalloc.h"

Go to the source code of this file.

Classes
struct	GPUViewportBatch
struct	GPUViewport
struct	[struct].g_viewport

Enumerations
enum	{ DO_UPDATE = (1 << 0) , GPU_VIEWPORT_STEREO = (1 << 1) }

Functions
void	GPU_viewport_tag_update (GPUViewport *viewport)
bool	GPU_viewport_do_update (GPUViewport *viewport)
GPUViewport *	GPU_viewport_create ()
GPUViewport *	GPU_viewport_stereo_create ()
DRWData **	GPU_viewport_data_get (GPUViewport *viewport)
static void	gpu_viewport_textures_create (GPUViewport *viewport)
static void	gpu_viewport_textures_free (GPUViewport *viewport)
void	GPU_viewport_bind (GPUViewport *viewport, int view, const rcti *rect)
void	GPU_viewport_bind_from_offscreen (GPUViewport *viewport, GPUOffScreen *ofs, bool is_xr_surface)
void	GPU_viewport_colorspace_set (GPUViewport *viewport, const ColorManagedViewSettings *view_settings, const ColorManagedDisplaySettings *display_settings, float dither)
void	GPU_viewport_stereo_composite (GPUViewport *viewport, Stereo3dFormat *stereo_format)
static void	gpu_viewport_draw_colormanaged (GPUViewport *viewport, int view, const rctf *rect_pos, const rctf *rect_uv, bool display_colorspace, bool do_overlay_merge)
void	GPU_viewport_draw_to_screen_ex (GPUViewport *viewport, int view, const rcti *rect, bool display_colorspace, bool do_overlay_merge)
void	GPU_viewport_draw_to_screen (GPUViewport *viewport, int view, const rcti *rect)
void	GPU_viewport_unbind_from_offscreen (GPUViewport *viewport, GPUOffScreen *ofs, bool display_colorspace, bool do_overlay_merge)
void	GPU_viewport_unbind (GPUViewport *)
int	GPU_viewport_active_view_get (GPUViewport *viewport)
bool	GPU_viewport_is_stereo_get (GPUViewport *viewport)
GPUTexture *	GPU_viewport_color_texture (GPUViewport *viewport, int view)
GPUTexture *	GPU_viewport_overlay_texture (GPUViewport *viewport, int view)
GPUTexture *	GPU_viewport_depth_texture (GPUViewport *viewport)
GPUFrameBuffer *	GPU_viewport_framebuffer_render_get (GPUViewport *viewport)
GPUFrameBuffer *	GPU_viewport_framebuffer_overlay_get (GPUViewport *viewport)
void	GPU_viewport_free (GPUViewport *viewport)
Viewport Batches
static const GPUVertFormat &	gpu_viewport_batch_format ()
static blender::gpu::Batch *	gpu_viewport_batch_create (const rctf *rect_pos, const rctf *rect_uv)
static blender::gpu::Batch *	gpu_viewport_batch_get (GPUViewport *viewport, const rctf *rect_pos, const rctf *rect_uv)
static void	gpu_viewport_batch_free (GPUViewport *viewport)

Variables
static struct	g_viewport = {{0}}

Detailed Description

System that manages viewport drawing.

Definition in file gpu_viewport.cc.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
DO_UPDATE
GPU_VIEWPORT_STEREO

Definition at line 88 of file gpu_viewport.cc.

Function Documentation

GPU_viewport_active_view_get()

int GPU_viewport_active_view_get

(

GPUViewport *

viewport

)

Definition at line 575 of file gpu_viewport.cc.

References GPUViewport::active_view, and GPU_viewport_active_view_get().

Referenced by DRWContext::acquire_data(), DRW_view_data_default_lists_from_viewport(), and GPU_viewport_active_view_get().

gpu_viewport_batch_create()

blender::gpu::Batch * gpu_viewport_batch_create ( const rctf * rect_pos, const rctf * rect_uv )

static

Definition at line 364 of file gpu_viewport.cc.

References copy_v2_fl2(), g_viewport, GPU_batch_create_ex(), GPU_BATCH_OWNS_VBO, GPU_PRIM_TRI_STRIP, GPU_vertbuf_attr_get_raw_data(), GPU_vertbuf_create_with_format, GPU_vertbuf_data_alloc(), GPU_vertbuf_raw_step(), gpu_viewport_batch_create(), gpu_viewport_batch_format(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by gpu_viewport_batch_create(), and gpu_viewport_batch_get().

gpu_viewport_batch_format()

const GPUVertFormat & gpu_viewport_batch_format ( )

static

Definition at line 352 of file gpu_viewport.cc.

References g_viewport, GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_vertformat_attr_add(), and gpu_viewport_batch_format().

Referenced by gpu_viewport_batch_create(), and gpu_viewport_batch_format().

gpu_viewport_batch_free()

void gpu_viewport_batch_free ( GPUViewport * viewport )

static

Definition at line 417 of file gpu_viewport.cc.

References GPUViewport::batch, GPUViewportBatch::batch, GPU_batch_discard(), and gpu_viewport_batch_free().

Referenced by gpu_viewport_batch_free(), and GPU_viewport_free().

gpu_viewport_batch_get()

blender::gpu::Batch * gpu_viewport_batch_get ( GPUViewport * viewport, const rctf * rect_pos, const rctf * rect_uv )

static

Definition at line 394 of file gpu_viewport.cc.

References GPUViewport::batch, GPUViewportBatch::batch, BLI_rctf_compare(), GPU_batch_discard(), gpu_viewport_batch_create(), gpu_viewport_batch_get(), and GPUViewportBatch::last_used_parameters.

Referenced by gpu_viewport_batch_get(), and gpu_viewport_draw_colormanaged().

GPU_viewport_bind()

void GPU_viewport_bind	(	GPUViewport *	viewport,
		int	view,
		const rcti *	rect )

Definition at line 197 of file gpu_viewport.cc.

References GPUViewport::active_view, BLI_rcti_size_x(), BLI_rcti_size_y(), copy_v2_v2_int(), DRW_gpu_context_enable(), GPU_viewport_bind(), gpu_viewport_textures_create(), gpu_viewport_textures_free(), rect_size(), and GPUViewport::size.

Referenced by GPU_viewport_bind(), blender::ed::vse::sequencer_ibuf_get(), and wm_draw_region_bind().

GPU_viewport_bind_from_offscreen()

void GPU_viewport_bind_from_offscreen	(	GPUViewport *	viewport,
		GPUOffScreen *	ofs,
		bool	is_xr_surface )

Should be called from DRW after DRW_gpu_context_enable.

Definition at line 215 of file gpu_viewport.cc.

References GPUViewport::depth_tx, fb(), GPU_offscreen_height(), GPU_offscreen_viewport_data_get(), GPU_offscreen_width(), GPU_viewport_bind_from_offscreen(), gpu_viewport_textures_create(), gpu_viewport_textures_free(), and GPUViewport::size.

Referenced by DRW_draw_render_loop_offscreen(), and GPU_viewport_bind_from_offscreen().

GPU_viewport_color_texture()

GPUTexture * GPU_viewport_color_texture	(	GPUViewport *	viewport,
		int	view )

Definition at line 585 of file gpu_viewport.cc.

References GPUViewport::color_render_tx, and GPU_viewport_color_texture().

Referenced by DRW_view_data_default_lists_from_viewport(), DRWContext::DRWContext(), GPU_viewport_color_texture(), ViewportColorSampleSession::init(), and wm_draw_region_texture().

GPU_viewport_colorspace_set()

void GPU_viewport_colorspace_set	(	GPUViewport *	viewport,
		const ColorManagedViewSettings *	view_settings,
		const ColorManagedDisplaySettings *	display_settings,
		float	dither )

HACK(fclem): We copy the settings here to avoid use after free if an update frees the scene and the viewport stays cached (see #75443). But this means the OCIO curve-mapping caching (which is based on CurveMap pointer address) cannot operate correctly and it will create a different OCIO processor for each viewport. We try to only reallocate the curve-map copy if needed to avoid unneeded cache invalidation.

Definition at line 238 of file gpu_viewport.cc.

References BKE_color_managed_display_settings_copy(), BKE_color_managed_view_settings_copy_keep_curve_mapping(), BKE_color_managed_view_settings_free(), BKE_curvemapping_copy(), CurveMapping::changed_timestamp, ColorManagedViewSettings::curve_mapping, GPUViewport::display_settings, GPUViewport::dither, GPUViewport::do_color_management, GPU_viewport_colorspace_set(), GPUViewport::orig_curve_mapping, and GPUViewport::view_settings.

Referenced by GPU_viewport_colorspace_set(), blender::ed::vse::preview_draw_begin(), and blender::draw::color_management::viewport_settings_apply().

GPU_viewport_create()

GPUViewport * GPU_viewport_create

(

)

Definition at line 105 of file gpu_viewport.cc.

References GPUViewport::active_view, GPUViewport::do_color_management, GPU_viewport_create(), MEM_callocN(), and GPUViewport::size.

Referenced by DRW_draw_render_loop_offscreen(), GPU_viewport_create(), GPU_viewport_stereo_create(), pygpu_offscreen_draw_view3d(), screen_opengl_render_init(), wm_draw_region_buffer_create(), and wm_xr_session_surface_offscreen_ensure().

GPU_viewport_data_get()

DRWData ** GPU_viewport_data_get

(

GPUViewport *

viewport

)

Definition at line 121 of file gpu_viewport.cc.

References GPUViewport::draw_data, and GPU_viewport_data_get().

Referenced by drw_viewport_data_ensure(), and GPU_viewport_data_get().

GPU_viewport_depth_texture()

GPUTexture * GPU_viewport_depth_texture

(

GPUViewport *

viewport

)

Definition at line 595 of file gpu_viewport.cc.

References GPUViewport::depth_tx, and GPU_viewport_depth_texture().

Referenced by DRW_draw_depth_loop(), DRW_view_data_default_lists_from_viewport(), gizmo_find_intersected_3d(), GPU_viewport_depth_texture(), view3d_depths_create(), and view3d_gpu_read_Z_pixels().

GPU_viewport_do_update()

bool GPU_viewport_do_update

(

GPUViewport *

viewport

)

Definition at line 98 of file gpu_viewport.cc.

References DO_UPDATE, GPUViewport::flag, GPU_viewport_do_update(), and ret.

Referenced by GPU_viewport_do_update(), and wm_region_test_render_do_draw().

gpu_viewport_draw_colormanaged()

void gpu_viewport_draw_colormanaged ( GPUViewport * viewport, int view, const rctf * rect_pos, const rctf * rect_uv, bool display_colorspace, bool do_overlay_merge )

static

Definition at line 427 of file gpu_viewport.cc.

References GPUViewport::color_overlay_tx, GPUViewport::color_render_tx, COLORMANAGE_VIEW_USE_HDR, GPUViewport::display_settings, GPUViewport::dither, GPUViewport::do_color_management, ColorManagedViewSettings::flag, GPU_batch_draw(), GPU_batch_program_set_builtin(), GPU_batch_program_set_imm_shader(), GPU_batch_uniform_1i, GPU_hdr_support(), GPU_SHADER_2D_IMAGE_OVERLAYS_MERGE, GPU_texture_bind(), GPU_texture_unbind(), gpu_viewport_batch_get(), gpu_viewport_draw_colormanaged(), IMB_colormanagement_finish_glsl_draw(), IMB_colormanagement_setup_glsl_draw_from_space(), immVertexFormat(), and GPUViewport::view_settings.

Referenced by gpu_viewport_draw_colormanaged(), GPU_viewport_draw_to_screen_ex(), and GPU_viewport_unbind_from_offscreen().

GPU_viewport_draw_to_screen()

void GPU_viewport_draw_to_screen	(	GPUViewport *	viewport,
		int	view,
		const rcti *	rect )

Merge and draw the buffers of viewport into the currently active framebuffer, performing color transform to display space.

Parameters

rect	Coordinates to draw into. By swapping min and max values, drawing can be done with inversed axis coordinates (upside down or sideways).

Definition at line 531 of file gpu_viewport.cc.

References GPU_viewport_draw_to_screen(), and GPU_viewport_draw_to_screen_ex().

Referenced by GPU_viewport_draw_to_screen(), and wm_draw_region_blit().

GPU_viewport_draw_to_screen_ex()

void GPU_viewport_draw_to_screen_ex	(	GPUViewport *	viewport,
		int	view,
		const rcti *	rect,
		bool	display_colorspace,
		bool	do_overlay_merge )

Version of GPU_viewport_draw_to_screen() that lets caller decide if display colorspace transform should be performed.

Definition at line 480 of file gpu_viewport.cc.

References BLI_assert, BLI_rcti_sanitize(), BLI_rcti_size_x(), BLI_rcti_size_y(), GPUViewport::color_render_tx, GLA_PIXEL_OFS, GPU_texture_height(), GPU_texture_width(), gpu_viewport_draw_colormanaged(), GPU_viewport_draw_to_screen_ex(), w(), rctf::xmax, rctf::xmin, rcti::xmin, rctf::ymax, rctf::ymin, and rcti::ymin.

Referenced by GPU_viewport_draw_to_screen(), GPU_viewport_draw_to_screen_ex(), and wm_xr_draw_viewport_buffers_to_active_framebuffer().

GPU_viewport_framebuffer_overlay_get()

GPUFrameBuffer * GPU_viewport_framebuffer_overlay_get

(

GPUViewport *

viewport

)

Definition at line 611 of file gpu_viewport.cc.

References GPU_framebuffer_ensure_config, GPU_viewport_framebuffer_overlay_get(), and GPUViewport::overlay_fb.

Referenced by blender::ed::vse::draw_registered_callbacks(), GPU_viewport_framebuffer_overlay_get(), blender::ed::space_node::node_draw_space(), blender::ed::vse::preview_draw_overlay_begin(), blender::ed::vse::sequencer_preview_draw_empty(), and blender::ed::vse::timeline_draw_context_get().

GPU_viewport_framebuffer_render_get()

GPUFrameBuffer * GPU_viewport_framebuffer_render_get

(

GPUViewport *

viewport

)

Color render and overlay frame-buffers for drawing outside of DRW module.

Definition at line 600 of file gpu_viewport.cc.

References GPU_framebuffer_ensure_config, GPU_viewport_framebuffer_render_get(), and GPUViewport::render_fb.

Referenced by GPU_viewport_framebuffer_render_get(), and blender::ed::vse::preview_draw_color_render_begin().

GPU_viewport_free()

void GPU_viewport_free

(

GPUViewport *

viewport

)

Must be executed inside Draw-manager OpenGL Context.

Definition at line 622 of file gpu_viewport.cc.

References BKE_color_managed_view_settings_free(), GPUViewport::draw_data, DRW_viewport_data_free(), gpu_viewport_batch_free(), GPU_viewport_free(), gpu_viewport_textures_free(), MEM_freeN(), and GPUViewport::view_settings.

Referenced by BPyGPUOffScreen__tp_dealloc(), DRW_draw_render_loop_offscreen(), GPU_viewport_free(), gpu_viewport_textures_create(), pygpu_offscreen_free(), screen_opengl_render_end(), wm_draw_region_buffer_free(), wm_xr_session_surface_free_data(), and wm_xr_session_surface_offscreen_ensure().

GPU_viewport_is_stereo_get()

bool GPU_viewport_is_stereo_get

(

GPUViewport *

viewport

)

Definition at line 580 of file gpu_viewport.cc.

References GPUViewport::flag, GPU_viewport_is_stereo_get(), and GPU_VIEWPORT_STEREO.

Referenced by GPU_viewport_is_stereo_get().

GPU_viewport_overlay_texture()

GPUTexture * GPU_viewport_overlay_texture	(	GPUViewport *	viewport,
		int	view )

Definition at line 590 of file gpu_viewport.cc.

References GPUViewport::color_overlay_tx, and GPU_viewport_overlay_texture().

Referenced by DRW_view_data_default_lists_from_viewport(), and GPU_viewport_overlay_texture().

GPU_viewport_stereo_composite()

void GPU_viewport_stereo_composite	(	GPUViewport *	viewport,
		Stereo3dFormat *	stereo_format )

Merge the stereo textures. color and overlay texture will be modified.

Definition at line 277 of file gpu_viewport.cc.

References Stereo3dFormat::anaglyph_type, GPUViewport::color_overlay_tx, GPUViewport::color_render_tx, Stereo3dFormat::display_mode, ELEM, Stereo3dFormat::flag, GPU_color_mask(), GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_framebuffer_bind(), GPU_framebuffer_ensure_config, GPU_framebuffer_restore(), GPU_matrix_identity_projection_set(), GPU_matrix_identity_set(), GPU_matrix_pop(), GPU_matrix_pop_projection(), GPU_matrix_push(), GPU_matrix_push_projection(), GPU_PRIM_TRI_STRIP, GPU_SHADER_2D_IMAGE_OVERLAYS_STEREO_MERGE, GPU_texture_bind(), GPU_texture_unbind(), GPU_vertformat_attr_add(), GPU_viewport_stereo_composite(), immBegin(), immBindBuiltinProgram(), immEnd(), immUnbindProgram(), immUniform1i(), immVertex2f(), immVertexFormat(), Stereo3dFormat::interlace_type, S3D_ANAGLYPH_GREENMAGENTA, S3D_ANAGLYPH_REDCYAN, S3D_ANAGLYPH_YELLOWBLUE, S3D_DISPLAY_ANAGLYPH, S3D_DISPLAY_INTERLACE, S3D_INTERLACE_SWAP, SET_FLAG_FROM_TEST, and GPUViewport::stereo_comp_fb.

Referenced by GPU_viewport_stereo_composite(), and wm_draw_area_offscreen().

GPU_viewport_stereo_create()

GPUViewport * GPU_viewport_stereo_create

(

)

Definition at line 114 of file gpu_viewport.cc.

References GPUViewport::flag, GPU_viewport_create(), GPU_VIEWPORT_STEREO, and GPU_viewport_stereo_create().

Referenced by GPU_viewport_stereo_create(), and wm_draw_region_buffer_create().

GPU_viewport_tag_update()

void GPU_viewport_tag_update

(

GPUViewport *

viewport

)

Definition at line 93 of file gpu_viewport.cc.

References DO_UPDATE, GPUViewport::flag, and GPU_viewport_tag_update().

Referenced by DRW_viewport_request_redraw(), ED_view3d_draw_offscreen(), GPU_viewport_tag_update(), and pygpu_offscreen_draw_view3d().

gpu_viewport_textures_create()

void gpu_viewport_textures_create ( GPUViewport * viewport )

static

Definition at line 126 of file gpu_viewport.cc.

References GPUViewport::color_overlay_tx, GPUViewport::color_render_tx, GPUViewport::depth_tx, GPUViewport::flag, GPU_DATA_FLOAT, GPU_DATA_UINT_24_8, GPU_DEPTH24_STENCIL8, GPU_RGBA16F, GPU_SRGB8_A8, GPU_texture_clear(), GPU_texture_create_2d(), GPU_TEXTURE_USAGE_ATTACHMENT, GPU_TEXTURE_USAGE_FORMAT_VIEW, GPU_TEXTURE_USAGE_HOST_READ, GPU_TEXTURE_USAGE_SHADER_READ, GPU_TEXTURE_USAGE_SHADER_WRITE, GPU_viewport_free(), GPU_VIEWPORT_STEREO, gpu_viewport_textures_create(), GPUViewport::size, size(), and UNPACK2.

Referenced by GPU_viewport_bind(), GPU_viewport_bind_from_offscreen(), and gpu_viewport_textures_create().

gpu_viewport_textures_free()

void gpu_viewport_textures_free ( GPUViewport * viewport )

static

Definition at line 183 of file gpu_viewport.cc.

References GPUViewport::color_overlay_tx, GPUViewport::color_render_tx, GPUViewport::depth_tx, GPU_FRAMEBUFFER_FREE_SAFE, GPU_TEXTURE_FREE_SAFE, gpu_viewport_textures_free(), i, GPUViewport::overlay_fb, GPUViewport::render_fb, and GPUViewport::stereo_comp_fb.

Referenced by GPU_viewport_bind(), GPU_viewport_bind_from_offscreen(), GPU_viewport_free(), and gpu_viewport_textures_free().

GPU_viewport_unbind()

void GPU_viewport_unbind

(

GPUViewport *

viewport

)

Definition at line 569 of file gpu_viewport.cc.

References DRW_gpu_context_disable(), GPU_framebuffer_restore(), and GPU_viewport_unbind().

Referenced by GPU_viewport_unbind(), blender::ed::vse::sequencer_ibuf_get(), and wm_draw_region_unbind().

GPU_viewport_unbind_from_offscreen()

void GPU_viewport_unbind_from_offscreen	(	GPUViewport *	viewport,
		GPUOffScreen *	ofs,
		bool	display_colorspace,
		bool	do_overlay_merge )

Clear vars assigned from offscreen, so we don't free data owned by GPUOffScreen.

Definition at line 536 of file gpu_viewport.cc.

References GPUViewport::color_render_tx, GPUViewport::depth_tx, GPU_DEPTH_NONE, GPU_depth_test(), GPU_offscreen_bind(), gpu_viewport_draw_colormanaged(), GPU_viewport_unbind_from_offscreen(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by DRW_draw_render_loop_offscreen(), and GPU_viewport_unbind_from_offscreen().

Variable Documentation

g_viewport

struct [struct].g_viewport g_viewport

Referenced by gpu_viewport_batch_create(), and gpu_viewport_batch_format().