GPU_framebuffer.hh File Reference

#include "GPU_common_types.hh"
#include "GPU_texture.hh"

Go to the source code of this file.

Classes
struct	GPUAttachment
struct	GPULoadStore

Enumerations
enum	eGPUFrameBufferBits { GPU_COLOR_BIT = (1 << 0) , GPU_DEPTH_BIT = (1 << 1) , GPU_STENCIL_BIT = (1 << 2) }

Functions
Creation
GPUFrameBuffer *	GPU_framebuffer_create (const char *name)
GPUFrameBuffer *	GPU_framebuffer_active_get ()
GPUFrameBuffer *	GPU_framebuffer_back_get ()
Empty frame-buffer
An empty frame-buffer is a frame-buffer with no attachments. This allow to rasterize geometry without creating any dummy attachments and write some computation results using other means (SSBOs, Images).
void	GPU_framebuffer_default_size (GPUFrameBuffer *fb, int width, int height)
Internal state
void	GPU_framebuffer_viewport_set (GPUFrameBuffer *fb, int x, int y, int width, int height)
void	GPU_framebuffer_multi_viewports_set (GPUFrameBuffer *gpu_fb, const int viewport_rects[GPU_MAX_VIEWPORTS][4])
void	GPU_framebuffer_viewport_get (GPUFrameBuffer *fb, int r_viewport[4])
void	GPU_framebuffer_viewport_reset (GPUFrameBuffer *fb)
Clearing
void	GPU_framebuffer_clear (GPUFrameBuffer *fb, eGPUFrameBufferBits buffers, const float clear_col[4], float clear_depth, unsigned int clear_stencil)
void	GPU_framebuffer_clear_color (GPUFrameBuffer *fb, const float clear_col[4])
void	GPU_framebuffer_clear_depth (GPUFrameBuffer *fb, float clear_depth)
void	GPU_framebuffer_clear_stencil (GPUFrameBuffer *fb, uint clear_stencil)
void	GPU_framebuffer_clear_color_depth (GPUFrameBuffer *fb, const float clear_col[4], float clear_depth)
void	GPU_framebuffer_clear_depth_stencil (GPUFrameBuffer *fb, float clear_depth, uint clear_stencil)
void	GPU_framebuffer_clear_color_depth_stencil (GPUFrameBuffer *fb, const float clear_col[4], float clear_depth, uint clear_stencil)
void	GPU_framebuffer_multi_clear (GPUFrameBuffer *fb, const float(*clear_colors)[4])
void	GPU_clear_color (float red, float green, float blue, float alpha)
void	GPU_clear_depth (float depth)
Debugging introspection API.
const char *	GPU_framebuffer_get_name (GPUFrameBuffer *fb)
Python API & meta-data
These are not intrinsic properties of a frame-buffer but they are stored inside the gpu::FrameBuffer structure for tracking purpose.
void **	GPU_framebuffer_py_reference_get (GPUFrameBuffer *fb)
void	GPU_framebuffer_py_reference_set (GPUFrameBuffer *fb, void **py_ref)
void	GPU_framebuffer_push (GPUFrameBuffer *fb)
GPUFrameBuffer *	GPU_framebuffer_pop ()
uint	GPU_framebuffer_stack_level_get ()
Deprecated
bool	GPU_framebuffer_bound (GPUFrameBuffer *fb)
void	GPU_framebuffer_read_depth (GPUFrameBuffer *fb, int x, int y, int width, int height, eGPUDataFormat data_format, void *r_data)
void	GPU_framebuffer_read_color (GPUFrameBuffer *fb, int x, int y, int width, int height, int channels, int slot, eGPUDataFormat data_format, void *r_data)
void	GPU_frontbuffer_read_color (int x, int y, int width, int height, int channels, eGPUDataFormat data_format, void *r_data)
void	GPU_framebuffer_blit (GPUFrameBuffer *fb_read, int read_slot, GPUFrameBuffer *fb_write, int write_slot, eGPUFrameBufferBits blit_buffers)
void	GPU_framebuffer_recursive_downsample (GPUFrameBuffer *fb, int max_level, void(*per_level_callback)(void *user_data, int level), void *user_data)
GPU OffScreen
A GPUOffScreen is a convenience type that holds a GPUFramebuffer and its associated GPUTextures. It is useful for quick drawing surface configuration. NOTE: They are still limited by the same single context limitation as #GPUFrameBuffer.
GPUOffScreen *	GPU_offscreen_create (int width, int height, bool with_depth_buffer, eGPUTextureFormat format, eGPUTextureUsage usage, bool clear, char err_out[256])
void	GPU_offscreen_free (GPUOffScreen *offscreen)
void	GPU_offscreen_bind (GPUOffScreen *offscreen, bool save)
void	GPU_offscreen_unbind (GPUOffScreen *offscreen, bool restore)
void	GPU_offscreen_read_color (GPUOffScreen *offscreen, eGPUDataFormat data_format, void *r_data)
void	GPU_offscreen_read_color_region (GPUOffScreen *offscreen, eGPUDataFormat data_format, int x, int y, int w, int h, void *r_data)
void	GPU_offscreen_draw_to_screen (GPUOffScreen *offscreen, int x, int y)
int	GPU_offscreen_width (const GPUOffScreen *offscreen)
int	GPU_offscreen_height (const GPUOffScreen *offscreen)
GPUTexture *	GPU_offscreen_color_texture (const GPUOffScreen *offscreen)
eGPUTextureFormat	GPU_offscreen_format (const GPUOffScreen *offscreen)
void	GPU_offscreen_viewport_data_get (GPUOffScreen *offscreen, GPUFrameBuffer **r_fb, GPUTexture **r_color, GPUTexture **r_depth)

Variables
static constexpr int	GPU_MAX_VIEWPORTS = 16

Free
#define	GPU_FRAMEBUFFER_FREE_SAFE(fb)
void	GPU_framebuffer_free (GPUFrameBuffer *fb)

Advanced binding control
#define	NULL_ATTACHMENT_COLOR
#define	NULL_LOAD_STORE
#define	GPU_framebuffer_bind_ex(_fb, ...)
#define	GPU_framebuffer_subpass_transition(_fb, ...)
void	GPU_framebuffer_bind_loadstore (GPUFrameBuffer *fb, const GPULoadStore *load_store_actions, uint load_store_actions_len)
void	GPU_framebuffer_subpass_transition_array (GPUFrameBuffer *fb, const GPUAttachmentState *attachment_states, uint attachment_len)

Attachments
#define	GPU_framebuffer_ensure_config(_fb, ...)
#define	GPU_ATTACHMENT_NONE
#define	GPU_ATTACHMENT_LEAVE
#define	GPU_ATTACHMENT_TEXTURE(_texture)
#define	GPU_ATTACHMENT_TEXTURE_MIP(_texture, _mip)
#define	GPU_ATTACHMENT_TEXTURE_LAYER(_texture, _layer)
#define	GPU_ATTACHMENT_TEXTURE_LAYER_MIP(_texture, _layer, _mip)
#define	GPU_ATTACHMENT_TEXTURE_CUBEFACE(_texture, _face)
#define	GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP(_texture, _face, _mip)
void	GPU_framebuffer_config_array (GPUFrameBuffer *fb, const GPUAttachment *config, int config_len)
void	GPU_framebuffer_texture_attach (GPUFrameBuffer *fb, GPUTexture *texture, int slot, int mip)
void	GPU_framebuffer_texture_layer_attach (GPUFrameBuffer *fb, GPUTexture *texture, int slot, int layer, int mip)
void	GPU_framebuffer_texture_cubeface_attach (GPUFrameBuffer *fb, GPUTexture *texture, int slot, int face, int mip)
void	GPU_framebuffer_texture_detach (GPUFrameBuffer *fb, GPUTexture *texture)
bool	GPU_framebuffer_check_valid (GPUFrameBuffer *fb, char err_out[256])

Binding
enum	eGPUBackBuffer { GPU_BACKBUFFER_LEFT = 0 , GPU_BACKBUFFER_RIGHT }
void	GPU_backbuffer_bind (eGPUBackBuffer back_buffer_type)
void	GPU_framebuffer_bind (GPUFrameBuffer *fb)
void	GPU_framebuffer_bind_no_srgb (GPUFrameBuffer *fb)
void	GPU_framebuffer_restore ()

Detailed Description

A GPUFramebuffer is a wrapper for a frame-buffer object (FBO) from the underlying graphic API.

A GPUFramebuffer is limited to one context and thus cannot be shared across different contexts. In the case this is needed, one must recreate the same GPUFramebuffer in each context.

Note that actual FBO creation & config is deferred until GPU_framebuffer_bind or GPU_framebuffer_check_valid is called. This means the context the GPUFramebuffer is bound with is the one active when GPU_framebuffer_bind is called.

When a GPUTexture is attached to a GPUFramebuffer a reference is created. Deleting either does not require any unbinding.

A GPUOffScreen is a convenience type that holds a GPUFramebuffer and its associated GPUTextures. It is useful for quick drawing surface configuration.

Definition in file GPU_framebuffer.hh.

Macro Definition Documentation

GPU_ATTACHMENT_LEAVE

#define GPU_ATTACHMENT_LEAVE

Value:

  { \
    nullptr, -1, -1, \
  }

Leave currently bound texture in this slot. DEPRECATED: Specify all textures for clarity.

Definition at line 266 of file GPU_framebuffer.hh.

GPU_ATTACHMENT_NONE

#define GPU_ATTACHMENT_NONE

Value:

  { \
    nullptr, -1, 0, \
  }

Empty bind point.

Definition at line 261 of file GPU_framebuffer.hh.

Referenced by blender::draw::overlay::Resources::acquire(), blender::gpu::FrameBuffer::attachment_remove(), blender::gpu::GLFrameBuffer::attachment_set_loadstore_op(), blender::image_engine::ScreenSpaceDrawingMode::begin_sync(), blender::gpu::GLFrameBuffer::bind(), blender::workbench::AntiAliasingPass::draw(), blender::workbench::DofPass::draw(), blender::workbench::Instance::draw(), blender::workbench::OpaquePass::draw(), blender::workbench::OutlinePass::draw(), blender::workbench::TransparentDepthPass::draw(), blender::workbench::TransparentPass::draw(), blender::workbench::VolumePass::draw(), blender::eevee::VolumeModule::draw_resolve(), DRW_draw_depth_loop(), blender::draw::Framebuffer::ensure(), gizmo_find_intersected_3d(), blender::gpu::tests::gpu_shader_lib_test(), pygpu_framebuffer_new_parse_arg(), blender::eevee::DepthOfField::render(), blender::draw::gpencil::render_result_combined(), blender::draw::gpencil::render_result_separated_pass(), blender::eevee::CaptureView::render_world(), blender::gpu::GLFrameBuffer::subpass_transition_impl(), blender::eevee::LookdevModule::sync(), blender::draw::test_draw_resource_id_gen(), blender::draw::test_draw_submit_only(), blender::draw::test_draw_visibility(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_cube(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), and view3d_gpu_read_Z_pixels().

GPU_ATTACHMENT_TEXTURE

#define GPU_ATTACHMENT_TEXTURE

(

_texture

)

Value:

  { \
    _texture, -1, 0, \
  }

Bind the first mip level of a texture (all layers).

Definition at line 271 of file GPU_framebuffer.hh.

Referenced by blender::draw::overlay::Resources::acquire(), blender::draw::gpencil::Instance::acquire_resources(), blender::draw::gpencil::Instance::begin_sync(), blender::image_engine::ScreenSpaceDrawingMode::begin_sync(), blender::render::hydra::GPURenderTaskDelegate::bind(), blender::workbench::AntiAliasingPass::draw(), blender::workbench::DofPass::draw(), blender::workbench::Instance::draw(), blender::workbench::OpaquePass::draw(), blender::workbench::OutlinePass::draw(), blender::workbench::ShadowPass::draw(), blender::workbench::TransparentDepthPass::draw(), blender::workbench::TransparentPass::draw(), blender::workbench::VolumePass::draw(), blender::draw::overlay::Outline::draw_line_only_ex(), blender::eevee::VolumeModule::draw_resolve(), DRW_draw_depth_loop(), blender::eevee::VolumeModule::end_sync(), gizmo_find_intersected_3d(), blender::gpu::tests::gpu_shader_lib_test(), blender::eevee::DepthOfField::render(), blender::eevee::ShadingView::render(), blender::draw::gpencil::render_init_buffers(), blender::eevee::CaptureView::render_probes(), blender::draw::gpencil::render_result_combined(), blender::draw::gpencil::render_result_separated_pass(), blender::eevee::ShadowModule::set_view(), blender::eevee::LookdevModule::sync(), blender::gpu::VKContext::sync_backbuffer(), blender::draw::test_draw_resource_id_gen(), blender::draw::test_draw_submit_only(), blender::draw::test_draw_visibility(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_depth(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), and view3d_gpu_read_Z_pixels().

GPU_ATTACHMENT_TEXTURE_CUBEFACE

#define GPU_ATTACHMENT_TEXTURE_CUBEFACE	(		_texture,
			_face )

Value:

  { \
    _texture, _face, 0, \
  }

NOTE: The cube-face variants are equivalent to the layer ones but give better semantic. Bind the first mip level of a cube-map _face texture.

Definition at line 294 of file GPU_framebuffer.hh.

Referenced by blender::eevee::CaptureView::render_probes(), blender::eevee::CaptureView::render_world(), and blender::gpu::tests::test_framebuffer_cube().

GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP

#define GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP	(		_texture,
			_face,
			_mip )

Value:

  { \
    _texture, _face, _mip, \
  }

Bind the _mip level of a cube-map _face texture.

Definition at line 299 of file GPU_framebuffer.hh.

Referenced by GPU_framebuffer_texture_cubeface_attach().

GPU_ATTACHMENT_TEXTURE_LAYER

#define GPU_ATTACHMENT_TEXTURE_LAYER	(		_texture,
			_layer )

Value:

  { \
    _texture, _layer, 0, \
  }

Bind the _layer layer of the first mip level of a texture.

Definition at line 281 of file GPU_framebuffer.hh.

Referenced by blender::eevee::ShadingView::render(), blender::eevee::CaptureView::render_probes(), and blender::eevee::PlanarProbeModule::set_view().

GPU_ATTACHMENT_TEXTURE_LAYER_MIP

#define GPU_ATTACHMENT_TEXTURE_LAYER_MIP	(		_texture,
			_layer,
			_mip )

Value:

  { \
    _texture, _layer, _mip, \
  }

Bind the _layer layer of the _mip level of a texture.

Definition at line 286 of file GPU_framebuffer.hh.

Referenced by GPU_framebuffer_texture_layer_attach().

GPU_ATTACHMENT_TEXTURE_MIP

#define GPU_ATTACHMENT_TEXTURE_MIP	(		_texture,
			_mip )

Value:

  { \
    _texture, -1, _mip, \
  }

Bind the _mip level of a texture (all layers).

Definition at line 276 of file GPU_framebuffer.hh.

Referenced by GPU_framebuffer_texture_attach().

GPU_framebuffer_bind_ex

#define GPU_framebuffer_bind_ex	(		_fb,
			... )

Value:

  { \
    GPULoadStore actions[] = __VA_ARGS__; \
    GPU_framebuffer_bind_loadstore(_fb, actions, (sizeof(actions) / sizeof(GPULoadStore))); \
  }

Definition at line 180 of file GPU_framebuffer.hh.

Referenced by blender::eevee::GBuffer::bind(), and blender::eevee::ShadowModule::set_view().

GPU_framebuffer_ensure_config

#define GPU_framebuffer_ensure_config	(		_fb,
			... )

Value:

  do { \
    if (*(_fb) == nullptr) { \
      *(_fb) = GPU_framebuffer_create(#_fb); \
    } \
    GPUAttachment config[] = __VA_ARGS__; \
    GPU_framebuffer_config_array(*(_fb), config, (sizeof(config) / sizeof(GPUAttachment))); \
  } while (0)

How to use GPU_framebuffer_ensure_config().

Example:

GPU_framebuffer_ensure_config(&fb, {
        GPU_ATTACHMENT_TEXTURE(depth), // must be depth buffer
        GPU_ATTACHMENT_TEXTURE(tex1),
        GPU_ATTACHMENT_TEXTURE_CUBEFACE(tex2, 0),
        GPU_ATTACHMENT_TEXTURE_LAYER_MIP(tex2, 0, 0)
})

Note

Unspecified attachments (i.e: those beyond the last GPU_ATTACHMENT_* in GPU_framebuffer_ensure_config list) are left unchanged.

Make sure that the dimensions of your textures matches otherwise you will have an invalid framebuffer error.

Definition at line 243 of file GPU_framebuffer.hh.

Referenced by blender::render::hydra::GPURenderTaskDelegate::bind(), DRW_draw_depth_loop(), DRW_view_data_default_lists_from_viewport(), blender::draw::overlay::Instance::end_sync(), gizmo_find_intersected_3d(), gpu_offscreen_fb_get(), blender::gpu::tests::gpu_shader_lib_test(), GPU_viewport_framebuffer_overlay_get(), GPU_viewport_framebuffer_render_get(), GPU_viewport_stereo_composite(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_depth(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_cube(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), view3d_gpu_read_Z_pixels(), and workbench_render_framebuffers_init().

GPU_FRAMEBUFFER_FREE_SAFE

#define GPU_FRAMEBUFFER_FREE_SAFE

(

fb

)

Value:

  do { \
    if (fb != nullptr) { \
      GPU_framebuffer_free(fb); \
      fb = nullptr; \
    } \
  } while (0)

Definition at line 85 of file GPU_framebuffer.hh.

Referenced by DRW_module_exit(), blender::draw::edit_select::Engine::free_static(), gpu_viewport_textures_free(), blender::gpu::tests::test_framebuffer_cube(), and blender::draw::Framebuffer::~Framebuffer().

GPU_framebuffer_subpass_transition

#define GPU_framebuffer_subpass_transition	(		_fb,
			... )

Value:

  { \
    GPUAttachmentState actions[] = __VA_ARGS__; \
    GPU_framebuffer_subpass_transition_array( \
        _fb, actions, (sizeof(actions) / sizeof(GPUAttachmentState))); \
  }

Definition at line 211 of file GPU_framebuffer.hh.

Referenced by blender::gpu::tests::test_framebuffer_subpass_input().

NULL_ATTACHMENT_COLOR

#define NULL_ATTACHMENT_COLOR

Value:

  { \
    0.0, 0.0, 0.0, 0.0 \
  }

Definition at line 141 of file GPU_framebuffer.hh.

Referenced by blender::gpu::FrameBuffer::recursive_downsample().

NULL_LOAD_STORE

#define NULL_LOAD_STORE

Value:

  { \
    GPU_LOADACTION_DONT_CARE, GPU_STOREACTION_DONT_CARE, NULL_ATTACHMENT_COLOR \
  }

Definition at line 145 of file GPU_framebuffer.hh.

Enumeration Type Documentation

eGPUBackBuffer

enum eGPUBackBuffer

Enumerator
GPU_BACKBUFFER_LEFT	Default framebuffer of a window. Always available.
GPU_BACKBUFFER_RIGHT	Right buffer of a window. Only available if window was created using stereo-view.

Definition at line 99 of file GPU_framebuffer.hh.

eGPUFrameBufferBits

enum eGPUFrameBufferBits

Enumerator
GPU_COLOR_BIT
GPU_DEPTH_BIT
GPU_STENCIL_BIT

Definition at line 32 of file GPU_framebuffer.hh.

Function Documentation

GPU_backbuffer_bind()

void GPU_backbuffer_bind

(

eGPUBackBuffer

back_buffer_type

)

Binds the active context's window frame-buffer. Note that GPU_BACKBUFFER_RIGHT is only available if the window was created using stereo-view.

Definition at line 329 of file gpu_framebuffer.cc.

References blender::gpu::Context::back_left, blender::gpu::Context::back_right, blender::gpu::FrameBuffer::bind(), blender::gpu::Context::get(), and GPU_BACKBUFFER_LEFT.

Referenced by wm_draw_window().

GPU_clear_color()

void GPU_clear_color	(	float	red,
		float	green,
		float	blue,
		float	alpha )

Clear all color attachment textures of the active frame-buffer with the given red, green, blue, alpha values.

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended. DEPRECATED: Use GPU_framebuffer_clear_color with explicit frame-buffer.

Definition at line 522 of file gpu_framebuffer.cc.

References blender::gpu::Context::active_fb, BLI_assert_msg, blender::gpu::FrameBuffer::clear(), blender::gpu::Context::get(), and GPU_COLOR_BIT.

Referenced by blender::ed::space_node::draw_background_color(), DRW_draw_render_loop_offscreen(), ED_region_clear(), hud_region_draw(), blender::ed::greasepencil::image_render::image_render_begin(), playanim_toscreen_ex(), region_clear_fully_transparent(), region_draw_status_text(), screen_opengl_render_doit(), UI_ThemeClearColor(), wm_draw_window_offscreen(), wm_draw_window_onscreen(), wm_main_playanim_intern(), and wm_window_ghostwindow_add().

GPU_clear_depth()

void GPU_clear_depth

(

float

depth

)

Clear the depth attachment texture of the active frame-buffer with the given depth value.

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended. DEPRECATED: Use GPU_framebuffer_clear_color with explicit frame-buffer.

Definition at line 531 of file gpu_framebuffer.cc.

References blender::gpu::Context::active_fb, BLI_assert_msg, blender::gpu::FrameBuffer::clear(), blender::gpu::Context::get(), and GPU_DEPTH_BIT.

Referenced by gpu_select_pick_begin(), gpu_select_pick_load_id(), gpu_select_query_begin(), blender::ed::greasepencil::image_render::image_render_begin(), screen_opengl_render_doit(), and wm_xr_draw_view().

GPU_framebuffer_active_get()

GPUFrameBuffer * GPU_framebuffer_active_get

(

)

Returns the current context active framebuffer. Return nullptr if no context is active.

Definition at line 346 of file gpu_framebuffer.cc.

References blender::gpu::Context::active_fb, blender::gpu::Context::get(), and blender::gpu::wrap().

Referenced by blender::gpu::GLTexture::clear(), blender::gpu::MTLTexture::clear(), blender::ed::space_node::draw_nodespace_back_pix(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), ED_region_do_draw(), ED_view3d_draw_offscreen_imbuf(), blender::draw::command::Clear::execute(), blender::draw::command::ClearMulti::execute(), blender::draw::command::SubPassTransition::execute(), GPU_framebuffer_bound(), GPU_offscreen_bind(), gpu_select_pick_load_id(), pygpu_framebuffer_stack_push_and_bind_or_error(), pygpu_state_active_framebuffer_get(), blender::render::hydra::ViewportEngine::render(), blender::ed::vse::sequencer_ibuf_get(), blender::eevee::ShadowModule::set_view(), wm_surface_make_drawable(), wm_surface_reset_drawable(), WM_system_gpu_context_activate(), WM_system_gpu_context_create(), WM_system_gpu_context_dispose(), WM_system_gpu_context_release(), wm_window_make_drawable(), wm_window_reset_drawable(), and wm_xr_session_surface_draw().

GPU_framebuffer_back_get()

GPUFrameBuffer * GPU_framebuffer_back_get

(

)

Returns the default (back-left) frame-buffer. It will always exists even if it's just a dummy. Return nullptr if no context is active.

Definition at line 352 of file gpu_framebuffer.cc.

References blender::gpu::Context::back_left, blender::gpu::Context::get(), and blender::gpu::wrap().

Referenced by drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), wm_surface_make_drawable(), wm_surface_reset_drawable(), WM_system_gpu_context_activate(), WM_system_gpu_context_create(), WM_system_gpu_context_dispose(), WM_system_gpu_context_release(), wm_window_make_drawable(), and wm_window_reset_drawable().

GPU_framebuffer_bind()

void GPU_framebuffer_bind

(

GPUFrameBuffer *

fb

)

Binds a #GPUFrameBuffer making it the active framebuffer for all geometry rendering.

Definition at line 294 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by blender::eevee::Film::accumulate(), blender::draw::gpencil::Instance::antialiasing_accumulate(), blender::draw::edit_select::Instance::begin_sync(), blender::draw::Framebuffer::bind(), blender::eevee::GBuffer::bind(), blender::render::hydra::GPURenderTaskDelegate::bind(), blender::gpu::GLTexture::clear(), blender::gpu::MTLTexture::clear(), blender::eevee::DeferredPipeline::debug_draw(), blender::eevee::HiZBuffer::debug_draw(), blender::eevee::LightModule::debug_draw(), blender::eevee::ShadowModule::debug_draw(), blender::eevee::Film::display(), blender::eevee::LookdevModule::display(), blender::draw::edit_select::Instance::draw(), blender::draw::gpencil::Instance::draw(), blender::draw::overlay::Facing::draw(), blender::draw::overlay::Fade::draw(), blender::draw::overlay::MeshUVs::draw(), blender::draw::overlay::ModeTransfer::draw(), blender::draw::overlay::Paints::draw(), blender::draw::overlay::Particles::draw(), blender::draw::overlay::Text::draw(), blender::draw::overlay::Cameras::draw_background_images(), blender::draw::overlay::Empties::draw_background_images(), blender::draw::overlay::Curves::draw_color_only(), blender::draw::overlay::GreasePencil::draw_color_only(), blender::draw::overlay::Grid::draw_color_only(), blender::draw::overlay::LightProbes::draw_color_only(), blender::draw::overlay::Meshes::draw_color_only(), blender::draw::overlay::MotionPath::draw_color_only(), blender::draw::overlay::Origins::draw_color_only(), blender::draw::overlay::XrayFade::draw_color_only(), blender::draw::overlay::Empties::draw_images(), blender::draw::overlay::Cameras::draw_in_front(), blender::draw::overlay::Empties::draw_in_front_images(), blender::draw::overlay::Armatures::draw_line(), blender::draw::overlay::AttributeViewer::draw_line(), blender::draw::overlay::Axes::draw_line(), blender::draw::overlay::Bounds::draw_line(), blender::draw::overlay::Cameras::draw_line(), blender::draw::overlay::Curves::draw_line(), blender::draw::overlay::Empties::draw_line(), blender::draw::overlay::Fluids::draw_line(), blender::draw::overlay::ForceFields::draw_line(), blender::draw::overlay::GreasePencil::draw_line(), blender::draw::overlay::Lattices::draw_line(), blender::draw::overlay::LightProbes::draw_line(), blender::draw::overlay::Lights::draw_line(), blender::draw::overlay::Meshes::draw_line(), blender::draw::overlay::Metaballs::draw_line(), blender::draw::overlay::Particles::draw_line(), blender::draw::overlay::PointClouds::draw_line(), blender::draw::overlay::Prepass::draw_line(), blender::draw::overlay::Relations::draw_line(), blender::draw::overlay::Sculpts::draw_line(), blender::draw::overlay::Speakers::draw_line(), blender::draw::overlay::Wireframe::draw_line(), blender::draw::overlay::Outline::draw_line_only_ex(), blender::draw::overlay::ImagePrepass::draw_on_render(), blender::draw::overlay::MeshUVs::draw_on_render(), blender::draw::overlay::Sculpts::draw_on_render(), blender::draw::overlay::Cursor::draw_output(), blender::ed::vse::draw_registered_callbacks(), blender::draw::overlay::Cameras::draw_scene_background_images(), blender::ed::vse::draw_timeline_post_view_callbacks(), blender::ed::vse::draw_timeline_pre_view_callbacks(), blender::image_engine::ScreenSpaceDrawingMode::draw_viewport(), drw_callbacks_post_scene(), drw_callbacks_post_scene_2D(), DRW_draw_depth_loop(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_select_loop(), DRW_select_buffer_read(), ED_region_do_draw(), ED_view3d_draw_offscreen_imbuf(), blender::draw::command::FramebufferBind::execute(), gizmo_find_intersected_3d(), GPU_offscreen_create(), GPU_offscreen_unbind(), blender::gpu::tests::gpu_shader_lib_test(), GPU_viewport_stereo_composite(), blender::ed::vse::preview_draw_color_render_begin(), pygpu_framebuffer_stack_pop_and_restore_or_error(), pygpu_framebuffer_stack_push_and_bind_or_error(), blender::eevee::BackgroundPipeline::render(), blender::eevee::DeferredLayer::render(), blender::eevee::DeferredProbePipeline::render(), blender::eevee::DepthOfField::render(), blender::eevee::PlanarProbePipeline::render(), blender::eevee::ShadingView::render(), blender::render::hydra::ViewportEngine::render(), blender::draw::gpencil::render_init_buffers(), blender::eevee::CaptureView::render_probes(), blender::draw::gpencil::render_result_combined(), blender::draw::gpencil::render_result_separated_pass(), blender::eevee::CaptureView::render_world(), blender::ed::vse::sequencer_ibuf_get(), blender::eevee::ShadowModule::set_view(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_depth(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_cube(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), blender::gpu::tests::ShaderSpecializationConst::validate(), view3d_gpu_read_Z_pixels(), write_render_color_output(), and write_render_z_output().

GPU_framebuffer_bind_loadstore()

void GPU_framebuffer_bind_loadstore	(	GPUFrameBuffer *	fb,
		const GPULoadStore *	load_store_actions,
		uint	load_store_actions_len )

Load store config array (load_store_actions) matches attachment structure of GPU_framebuffer_config_array. This allows us to explicitly specify whether attachment data needs to be loaded and stored on a per-attachment basis. This enables a number of bandwidth optimizations:

• No need to load contents if subsequent work is over-writing every pixel.
• No need to store attachments whose contents are not used beyond this pass e.g. depth buffer.
• State can be customized at bind-time rather than applying to the frame-buffer object as a whole.

NOTE: Using GPU_framebuffer_clear_* functions in conjunction with a custom load-store configuration is invalid. Instead, utilize GPU_LOADACTION_CLEAR and provide a clear color as the third parameter in GPULoadStore action.

For Color attachments: {GPU_LOADACTION_CLEAR, GPU_STOREACTION_STORE, {Rf, Gf, Bf, Af}} For Depth attachments: {GPU_LOADACTION_CLEAR, GPU_STOREACTION_STORE, {Df}}

Example:

GPU_framebuffer_bind_loadstore(&fb, {
        {GPU_LOADACTION_LOAD, GPU_STOREACTION_DONT_CARE} // must be depth buffer
        {GPU_LOADACTION_LOAD, GPU_STOREACTION_STORE}, // Color attachment 0
        {GPU_LOADACTION_DONT_CARE, GPU_STOREACTION_STORE}, // Color attachment 1
        {GPU_LOADACTION_DONT_CARE, GPU_STOREACTION_STORE} // Color attachment 2
})

Definition at line 302 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

GPU_framebuffer_bind_no_srgb()

void GPU_framebuffer_bind_no_srgb

(

GPUFrameBuffer *

fb

)

Same as GPU_framebuffer_bind but do not enable the SRGB transform.

Definition at line 323 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by blender::ed::space_node::draw_nodespace_back_pix(), blender::ed::vse::draw_registered_callbacks(), blender::ed::vse::draw_timeline_post_view_callbacks(), blender::ed::vse::draw_timeline_pre_view_callbacks(), blender::ed::space_node::node_draw_space(), blender::ed::vse::preview_draw_overlay_begin(), and blender::ed::vse::sequencer_preview_draw_empty().

GPU_framebuffer_blit()

void GPU_framebuffer_blit	(	GPUFrameBuffer *	fb_read,
		int	read_slot,
		GPUFrameBuffer *	fb_write,
		int	write_slot,
		eGPUFrameBufferBits	blit_buffers )

Copy the content of fb_read attachments to the fb_read attachments. The attachments types are chosen by blit_buffers . Only one color buffer can by copied at a time and its index is chosen by read_slot and write_slot. The source and destination frame-buffers dimensions have to match. DEPRECATED: Prefer using GPU_texture_copy().

Definition at line 569 of file gpu_framebuffer.cc.

References blender::gpu::Context::active_fb, blender::gpu::FrameBuffer::bind(), BLI_assert, blender::gpu::FrameBuffer::blit_to(), blender::gpu::FrameBuffer::color_tex(), blender::gpu::FrameBuffer::depth_tex(), blender::gpu::Context::get(), GPU_DEPTH_BIT, GPU_STENCIL_BIT, GPU_texture_format(), GPU_texture_has_depth_format(), GPU_texture_has_stencil_format(), and blender::gpu::unwrap().

GPU_framebuffer_bound()

bool GPU_framebuffer_bound

(

GPUFrameBuffer *

fb

)

Return true if framebuffer is the active framebuffer of the active context.

Note

return false if no context is active.

this is undefined behavior if framebuffer is nullptr. DEPRECATED: Kept only because of Python GPU API.

Definition at line 358 of file gpu_framebuffer.cc.

References GPU_framebuffer_active_get().

Referenced by pygpu_framebuffer_clear(), pygpu_framebuffer_is_bound(), and pygpu_framebuffer_stack_pop_and_restore_or_error().

GPU_framebuffer_check_valid()

bool GPU_framebuffer_check_valid	(	GPUFrameBuffer *	fb,
		char	err_out[256] )

Checks a framebuffer current configuration for errors. Checks for texture size mismatch, incompatible attachment, incomplete textures etc...

Note

This binds the framebuffer to the active context. err_out is an error output buffer.

Returns

false if the framebuffer is invalid.

Definition at line 365 of file gpu_framebuffer.cc.

References blender::gpu::unwrap().

Referenced by draw_select_framebuffer_depth_only_setup(), GPU_offscreen_create(), and workbench_render_framebuffers_init().

GPU_framebuffer_clear()

void GPU_framebuffer_clear	(	GPUFrameBuffer *	fb,
		eGPUFrameBufferBits	buffers,
		const float	clear_col[4],
		float	clear_depth,
		unsigned int	clear_stencil )

Clear the frame-buffer attachments. buffers controls the types of attachments to clear. Setting GPU_COLOR_BIT will clear all the color attachment. Each attachment gets cleared to the value of its type:

• color attachments gets cleared to clear_col .
• depth attachment gets cleared to clear_depth .
• stencil attachment gets cleared to clear_stencil .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 466 of file gpu_framebuffer.cc.

References BLI_assert_msg, buffers, and blender::gpu::unwrap().

Referenced by blender::draw::command::Clear::execute(), GPU_framebuffer_clear_color(), GPU_framebuffer_clear_color_depth(), GPU_framebuffer_clear_color_depth_stencil(), GPU_framebuffer_clear_depth(), GPU_framebuffer_clear_depth_stencil(), GPU_framebuffer_clear_stencil(), and pygpu_framebuffer_clear().

GPU_framebuffer_clear_color()

void GPU_framebuffer_clear_color	(	GPUFrameBuffer *	fb,
		const float	clear_col[4] )

Clear all color attachment textures with the value clear_col .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 478 of file gpu_framebuffer.cc.

References fb(), GPU_COLOR_BIT, and GPU_framebuffer_clear().

Referenced by blender::eevee::Film::accumulate(), blender::image_engine::ScreenSpaceDrawingMode::draw_viewport(), GPU_offscreen_create(), blender::ed::vse::preview_draw_color_render_begin(), blender::eevee::ShadingView::render(), blender::draw::gpencil::render_init_buffers(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_cube(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), and blender::gpu::tests::test_framebuffer_subpass_input().

GPU_framebuffer_clear_color_depth()

void GPU_framebuffer_clear_color_depth	(	GPUFrameBuffer *	fb,
		const float	clear_col[4],
		float	clear_depth )

Clear all color attachment textures with the value clear_col and the depth attachment texture with the value clear_depth .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 488 of file gpu_framebuffer.cc.

References fb(), GPU_COLOR_BIT, GPU_DEPTH_BIT, and GPU_framebuffer_clear().

Referenced by blender::draw::edit_select::Instance::begin_sync(), blender::render::hydra::GPURenderTaskDelegate::bind(), blender::eevee::Instance::draw_viewport(), GPU_offscreen_create(), blender::eevee::ShadingView::render(), and blender::eevee::CaptureView::render_probes().

GPU_framebuffer_clear_color_depth_stencil()

void GPU_framebuffer_clear_color_depth_stencil	(	GPUFrameBuffer *	fb,
		const float	clear_col[4],
		float	clear_depth,
		uint	clear_stencil )

Clear the depth attachment texture with the value clear_depth , the stencil attachment with the value clear_stencil and all the color attachments with the value clear_col .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 505 of file gpu_framebuffer.cc.

References fb(), GPU_COLOR_BIT, GPU_DEPTH_BIT, GPU_framebuffer_clear(), and GPU_STENCIL_BIT.

GPU_framebuffer_clear_depth()

void GPU_framebuffer_clear_depth	(	GPUFrameBuffer *	fb,
		float	clear_depth )

Clear the depth attachment texture with the value clear_depth .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 483 of file gpu_framebuffer.cc.

References fb(), GPU_DEPTH_BIT, and GPU_framebuffer_clear().

Referenced by blender::draw::Framebuffer::clear_depth(), blender::draw::edit_select::Instance::draw(), DRW_draw_depth_loop(), DRW_draw_select_loop(), blender::eevee::PlanarProbePipeline::render(), blender::draw::gpencil::render_init_buffers(), and blender::gpu::tests::test_framebuffer_clear_depth().

GPU_framebuffer_clear_depth_stencil()

void GPU_framebuffer_clear_depth_stencil	(	GPUFrameBuffer *	fb,
		float	clear_depth,
		uint	clear_stencil )

Clear the depth attachment texture with the value clear_depth and the stencil attachment with the value clear_stencil .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 500 of file gpu_framebuffer.cc.

References fb(), GPU_DEPTH_BIT, GPU_framebuffer_clear(), and GPU_STENCIL_BIT.

Referenced by blender::workbench::Instance::draw(), drw_draw_render_loop_2d(), and drw_draw_render_loop_3d().

GPU_framebuffer_clear_stencil()

void GPU_framebuffer_clear_stencil	(	GPUFrameBuffer *	fb,
		uint	clear_stencil )

Clear the stencil attachment with the value clear_stencil .

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 495 of file gpu_framebuffer.cc.

References fb(), GPU_framebuffer_clear(), and GPU_STENCIL_BIT.

Referenced by blender::eevee::GBuffer::bind(), and blender::workbench::OpaquePass::draw().

GPU_framebuffer_config_array()

void GPU_framebuffer_config_array	(	GPUFrameBuffer *	fb,
		const GPUAttachment *	config,
		int	config_len )

First GPUAttachment in *config is always the depth/depth_stencil buffer. Following #GPUAttachments are color buffers. Setting GPUAttachment.mip to -1 will leave the texture in this slot. Setting GPUAttachment.tex to nullptr will detach the texture in this slot.

Definition at line 404 of file gpu_framebuffer.cc.

References fb(), GPU_FB_COLOR_ATTACHMENT0, GPU_FB_DEPTH_ATTACHMENT, GPU_FB_DEPTH_STENCIL_ATTACHMENT, GPU_texture_has_stencil_format(), GPUAttachment::mip, GPUAttachment::tex, and blender::gpu::unwrap().

Referenced by blender::draw::Framebuffer::ensure(), and pygpu_framebuffer__tp_new().

GPU_framebuffer_create()

GPUFrameBuffer * GPU_framebuffer_create

(

const char *

name

)

Create a #GPUFrameBuffer object. It is not configured and not bound to a specific context until GPU_framebuffer_bind() is called.

Definition at line 275 of file gpu_framebuffer.cc.

References blender::gpu::GPUBackend::get(), and blender::gpu::wrap().

Referenced by blender::render::hydra::GPURenderTaskDelegate::bind(), draw_select_framebuffer_depth_only_setup(), blender::draw::Framebuffer::ensure(), blender::draw::Framebuffer::ensure(), blender::gpu::tests::gpu_shader_lib_test(), pygpu_framebuffer__tp_new(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_depth(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), and blender::gpu::tests::ShaderSpecializationConst::validate().

GPU_framebuffer_default_size()

void GPU_framebuffer_default_size	(	GPUFrameBuffer *	fb,
		int	width,
		int	height )

Default size is used if the frame-buffer contains no attachments. It needs to be re-specified each time an attachment is added.

Definition at line 435 of file gpu_framebuffer.cc.

References blender::gpu::unwrap().

Referenced by blender::draw::Framebuffer::ensure(), and blender::gpu::tests::ShaderSpecializationConst::validate().

GPU_framebuffer_free()

void GPU_framebuffer_free

(

GPUFrameBuffer *

fb

)

Create a #GPUFrameBuffer object. It is not configured and not bound to a specific context until GPU_framebuffer_bind() is called.

Definition at line 282 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by DRW_draw_depth_loop(), gizmo_find_intersected_3d(), gpu_offscreen_fb_get(), GPU_offscreen_free(), blender::gpu::tests::gpu_shader_lib_test(), pygpu_framebuffer_free_if_possible(), blender::gpu::tests::test_framebuffer_clear_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_clear_color_single_attachment(), blender::gpu::tests::test_framebuffer_clear_depth(), blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_framebuffer_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), blender::render::hydra::GPURenderTaskDelegate::unbind(), blender::gpu::tests::ShaderSpecializationConst::validate(), view3d_gpu_read_Z_pixels(), and blender::gpu::GLTexture::~GLTexture().

GPU_framebuffer_get_name()

const char * GPU_framebuffer_get_name

(

GPUFrameBuffer *

fb

)

Definition at line 287 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by blender::draw::command::FramebufferBind::serialize().

GPU_framebuffer_multi_clear()

void GPU_framebuffer_multi_clear	(	GPUFrameBuffer *	fb,
		const float(*)	clear_colors[4] )

Clear each color attachment texture attached to this frame-buffer with a different color. IMPORTANT: The size of clear_colors must match the number of color attachments.

Note

GPU_write_mask, and stencil test do not affect this command.

Viewport and scissor regions affect this command but are not efficient nor recommended.

Definition at line 514 of file gpu_framebuffer.cc.

References BLI_assert_msg, fb(), and blender::gpu::unwrap().

Referenced by blender::draw::gpencil::Instance::draw(), blender::workbench::Instance::draw(), blender::draw::command::ClearMulti::execute(), and blender::gpu::tests::test_framebuffer_clear_multiple_color_multiple_attachments().

GPU_framebuffer_multi_viewports_set()

void GPU_framebuffer_multi_viewports_set	(	GPUFrameBuffer *	gpu_fb,
		const int	viewport_rects[GPU_MAX_VIEWPORTS][4] )

Similar to GPU_framebuffer_viewport_set() but specify the bounds of all 16 viewports. By default geometry renders only to the first viewport. That can be changed by setting gpu_ViewportIndex in the vertex.

Note

Viewport and scissor size is stored per frame-buffer.

Must be called after first bind.

Definition at line 448 of file gpu_framebuffer.cc.

References GPU_MAX_VIEWPORTS, and blender::gpu::unwrap().

Referenced by blender::eevee::ShadowModule::set_view(), and blender::gpu::tests::test_framebuffer_multi_viewport().

GPU_framebuffer_pop()

GPUFrameBuffer * GPU_framebuffer_pop

(

)

Definition at line 652 of file gpu_framebuffer.cc.

References BLI_assert, and FrameBufferStack.

Referenced by GPU_offscreen_unbind(), and pygpu_framebuffer_stack_pop_and_restore_or_error().

GPU_framebuffer_push()

void GPU_framebuffer_push

(

GPUFrameBuffer *

fb

)

Keep a stack of bound frame-buffer to allow scoped binding of frame-buffer in python. This is also used by GPUOffScreen to save/restore the current frame-buffers.

Note

This isn't thread safe.

Definition at line 645 of file gpu_framebuffer.cc.

References BLI_assert, fb(), FRAMEBUFFER_STACK_DEPTH, and FrameBufferStack.

Referenced by GPU_offscreen_bind(), and pygpu_framebuffer_stack_push_and_bind_or_error().

GPU_framebuffer_py_reference_get()

void ** GPU_framebuffer_py_reference_get

(

GPUFrameBuffer *

fb

)

Reference of a pointer that needs to be cleaned when deallocating the frame-buffer. Points to BPyGPUFrameBuffer.fb

Definition at line 618 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by BPyGPUFrameBuffer_CreatePyObject().

GPU_framebuffer_py_reference_set()

void GPU_framebuffer_py_reference_set	(	GPUFrameBuffer *	fb,
		void **	py_ref )

Definition at line 623 of file gpu_framebuffer.cc.

References BLI_assert, fb(), and blender::gpu::unwrap().

Referenced by BPyGPUFrameBuffer_CreatePyObject(), and pygpu_framebuffer_free_safe().

GPU_framebuffer_read_color()

void GPU_framebuffer_read_color	(	GPUFrameBuffer *	fb,
		int	x,
		int	y,
		int	width,
		int	height,
		int	channels,
		int	slot,
		eGPUDataFormat	data_format,
		void *	r_data )

Read a region of a framebuffer color attachment and copy it to r_data . The pixel data will be converted to data_format but it needs to be compatible with the attachment type. DEPRECATED: Prefer using GPU_texture_read().

Definition at line 547 of file gpu_framebuffer.cc.

References data, fb(), GPU_COLOR_BIT, blender::gpu::unwrap(), w(), x, and y.

Referenced by DRW_select_buffer_read(), GPU_offscreen_read_color_region(), pygpu_framebuffer_read_color(), blender::draw::gpencil::render_result_combined(), blender::draw::gpencil::render_result_separated_pass(), and write_render_color_output().

GPU_framebuffer_read_depth()

void GPU_framebuffer_read_depth	(	GPUFrameBuffer *	fb,
		int	x,
		int	y,
		int	width,
		int	height,
		eGPUDataFormat	data_format,
		void *	r_data )

Read a region of the framebuffer depth attachment and copy it to r_data . The pixel data will be converted to data_format but it needs to be compatible with the attachment type. DEPRECATED: Prefer using GPU_texture_read().

Definition at line 540 of file gpu_framebuffer.cc.

References data, fb(), GPU_DEPTH_BIT, blender::gpu::unwrap(), w(), x, and y.

Referenced by gpu_select_pick_load_id(), pygpu_framebuffer_read_depth(), blender::draw::gpencil::render_result_z(), view3d_gpu_read_Z_pixels(), and write_render_z_output().

GPU_framebuffer_recursive_downsample()

void GPU_framebuffer_recursive_downsample	(	GPUFrameBuffer *	fb,
		int	max_level,
		void(*	per_level_callback )(void *user_data, int level),
		void *	user_data )

Call per_level_callback after binding each framebuffer attachment mip level up until max_level . Each attachment texture sampler mip range is set to not overlap the currently processed level. This is used for generating custom mip-map chains where each level needs access to the one above. DEPRECATED: Prefer using a compute shader with arbitrary imageLoad/Store for this purpose as it is clearer and likely faster with optimizations.

Definition at line 609 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by blender::workbench::DofPass::draw().

GPU_framebuffer_restore()

void GPU_framebuffer_restore

(

)

Binds back the active context's default frame-buffer. Equivalent to GPU_backbuffer_bind(GPU_BACKBUFFER_LEFT).

Definition at line 341 of file gpu_framebuffer.cc.

References blender::gpu::Context::back_left, blender::gpu::FrameBuffer::bind(), and blender::gpu::Context::get().

Referenced by blender::ed::space_node::draw_nodespace_back_pix(), DRW_custom_pipeline_end(), DRW_draw_depth_loop(), drw_draw_render_loop_2d(), drw_draw_render_loop_3d(), DRW_draw_render_loop_offscreen(), DRW_draw_select_loop(), DRW_render_gpencil(), DRW_render_to_image(), DRW_select_buffer_read(), ED_view3d_draw_offscreen_imbuf(), gizmo_find_intersected_3d(), GPU_offscreen_create(), GPU_offscreen_unbind(), GPU_viewport_stereo_composite(), GPU_viewport_unbind(), blender::ed::vse::sequencer_ibuf_get(), view3d_gpu_read_Z_pixels(), wm_xr_draw_view(), wm_xr_session_surface_draw(), blender::gpu::GLFrameBuffer::~GLFrameBuffer(), and blender::gpu::MTLFrameBuffer::~MTLFrameBuffer().

GPU_framebuffer_stack_level_get()

uint GPU_framebuffer_stack_level_get

(

)

Definition at line 659 of file gpu_framebuffer.cc.

References FrameBufferStack.

Referenced by pygpu_framebuffer_stack_context_enter(), pygpu_framebuffer_stack_context_exit(), pygpu_framebuffer_stack_pop_and_restore_or_error(), pygpu_framebuffer_stack_push_and_bind_or_error(), pygpu_offscreen_stack_context_enter(), and pygpu_offscreen_stack_context_exit().

GPU_framebuffer_subpass_transition_array()

void GPU_framebuffer_subpass_transition_array	(	GPUFrameBuffer *	fb,
		const GPUAttachmentState *	attachment_states,
		uint	attachment_len )

Sub-pass config array matches attachment structure of GPU_framebuffer_config_array. This allows to explicitly specify attachment state within the next sub-pass. This enables a number of bandwidth optimizations specially on Tile Based Deferred Renderers where the attachments can be kept into tile memory and used in place for later sub-passes.

IMPORTANT: When using this, the framebuffer initial state is undefined. A sub-pass transition need to be issued before any draw-call.

Example:

GPU_framebuffer_bind_loadstore(&fb, {
        GPU_ATTACHMENT_WRITE,  // must be depth buffer
        GPU_ATTACHMENT_READ,   // Color attachment 0
        GPU_ATTACHMENT_IGNORE, // Color attachment 1
        GPU_ATTACHMENT_WRITE}  // Color attachment 2
})

Note

Excess attachments will have no effect as long as they are GPU_ATTACHMENT_IGNORE.

Definition at line 315 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

Referenced by blender::draw::command::SubPassTransition::execute().

GPU_framebuffer_texture_attach()

void GPU_framebuffer_texture_attach	(	GPUFrameBuffer *	fb,
		GPUTexture *	texture,
		int	slot,
		int	mip )

Attach an entire texture mip level to a #GPUFrameBuffer. Changes will only take effect next time GPU_framebuffer_bind() is called. slot is the color texture slot to bind this texture to. Must be 0 if it is the depth texture. mip is the mip level of this texture to attach to the framebuffer. DEPRECATED: Prefer using multiple #GPUFrameBuffer with different configurations with GPU_framebuffer_config_array().

Definition at line 379 of file gpu_framebuffer.cc.

References fb(), GPU_ATTACHMENT_TEXTURE_MIP, and gpu_framebuffer_texture_attach_ex().

Referenced by draw_select_framebuffer_depth_only_setup().

GPU_framebuffer_texture_cubeface_attach()

void GPU_framebuffer_texture_cubeface_attach	(	GPUFrameBuffer *	fb,
		GPUTexture *	texture,
		int	slot,
		int	face,
		int	mip )

Attach a single cube-face of an cube-map texture mip level to a #GPUFrameBuffer. Changes will only take effect next time GPU_framebuffer_bind() is called. slot is the color texture slot to bind this texture to. Must be 0 if it is the depth texture. face is the cube-face of this cube-map texture to attach to the framebuffer. mip is the mip level of this texture to attach to the framebuffer. DEPRECATED: Prefer using multiple #GPUFrameBuffer with different configurations with GPU_framebuffer_config_array().

Definition at line 392 of file gpu_framebuffer.cc.

References fb(), GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP, and gpu_framebuffer_texture_attach_ex().

GPU_framebuffer_texture_detach()

void GPU_framebuffer_texture_detach	(	GPUFrameBuffer *	fb,
		GPUTexture *	texture )

Detach a texture from a #GPUFrameBuffer. The texture must be attached. Changes will only take effect next time GPU_framebuffer_bind() is called. DEPRECATED: Prefer using multiple #GPUFrameBuffer with different configurations with GPU_framebuffer_config_array().

Definition at line 399 of file gpu_framebuffer.cc.

References fb(), and blender::gpu::unwrap().

GPU_framebuffer_texture_layer_attach()

void GPU_framebuffer_texture_layer_attach	(	GPUFrameBuffer *	fb,
		GPUTexture *	texture,
		int	slot,
		int	layer,
		int	mip )

Attach a single layer of an array texture mip level to a #GPUFrameBuffer. Changes will only take effect next time GPU_framebuffer_bind() is called. slot is the color texture slot to bind this texture to. Must be 0 if it is the depth texture. layer is the layer of this array texture to attach to the framebuffer. mip is the mip level of this texture to attach to the framebuffer. DEPRECATED: Prefer using multiple #GPUFrameBuffer with different configurations with GPU_framebuffer_config_array().

Definition at line 385 of file gpu_framebuffer.cc.

References fb(), GPU_ATTACHMENT_TEXTURE_LAYER_MIP, and gpu_framebuffer_texture_attach_ex().

GPU_framebuffer_viewport_get()

void GPU_framebuffer_viewport_get	(	GPUFrameBuffer *	fb,
		int	r_viewport[4] )

Return the viewport offset and size in a int quadruple: (x, y, width, height).

Note

Viewport and scissor size is stored per frame-buffer.

Definition at line 454 of file gpu_framebuffer.cc.

References blender::gpu::unwrap().

Referenced by pygpu_framebuffer_viewport_get().

GPU_framebuffer_viewport_reset()

void GPU_framebuffer_viewport_reset

(

GPUFrameBuffer *

fb

)

Reset a frame-buffer viewport bounds to its attachment(s) size.

Note

Viewport and scissor size is stored per frame-buffer.

Definition at line 459 of file gpu_framebuffer.cc.

References blender::gpu::unwrap().

Referenced by blender::eevee::LookdevModule::display(), and blender::eevee::Instance::draw().

GPU_framebuffer_viewport_set()

void GPU_framebuffer_viewport_set	(	GPUFrameBuffer *	fb,
		int	x,
		int	y,
		int	width,
		int	height )

Set a the viewport offset and size. These are reset to the original dimensions explicitly (using GPU_framebuffer_viewport_reset()) or when binding the frame-buffer after modifying its attachments.

Note

Viewport and scissor size is stored per frame-buffer.

Setting a singular viewport will only change the state of the first viewport.

Must be called after first bind.

Definition at line 442 of file gpu_framebuffer.cc.

References blender::gpu::unwrap(), x, and y.

Referenced by blender::eevee::Film::accumulate(), blender::eevee::Film::display(), and pygpu_framebuffer_viewport_set().

GPU_frontbuffer_read_color()

void GPU_frontbuffer_read_color	(	int	x,
		int	y,
		int	width,
		int	height,
		int	channels,
		eGPUDataFormat	data_format,
		void *	r_data )

Read a the color of the window screen as it is currently displayed (so the previously rendered back-buffer). DEPRECATED: This isn't even working correctly on some implementation. TODO: Emulate this by doing some slow texture copy on the backend side or try to read the areas offscreen textures directly.

Definition at line 561 of file gpu_framebuffer.cc.

References data, blender::gpu::Context::front_left, blender::gpu::Context::get(), GPU_COLOR_BIT, blender::gpu::FrameBuffer::read(), w(), x, and y.

Referenced by WM_window_pixels_read_from_frontbuffer(), and WM_window_pixels_read_sample_from_frontbuffer().

GPU_offscreen_bind()

void GPU_offscreen_bind	(	GPUOffScreen *	offscreen,
		bool	save )

Unbind a GPUOffScreen from a #GPUContext. If save is true, it will save the currently bound framebuffer into a stack.

Definition at line 808 of file gpu_framebuffer.cc.

References fb(), GPU_framebuffer_active_get(), GPU_framebuffer_push(), gpu_offscreen_fb_get(), and blender::gpu::unwrap().

Referenced by blender::gpu::tests::blend_test(), DRW_draw_render_loop_offscreen(), ED_view3d_draw_offscreen_imbuf(), GPU_viewport_unbind_from_offscreen(), blender::ed::greasepencil::image_render::image_render_begin(), pygpu_offscreen_draw_view3d(), pygpu_offscreen_stack_context_enter(), screen_opengl_render_doit(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::vertex_buffer_fetch_mode(), wm_draw_region_bind(), wm_draw_window(), WM_window_pixels_read_from_offscreen(), WM_window_pixels_read_sample_from_offscreen(), and wm_xr_draw_view().

GPU_offscreen_color_texture()

GPUTexture * GPU_offscreen_color_texture

(

const GPUOffScreen *

offscreen

)

Return the color texture of a GPUOffScreen. Does not give ownership.

Note

only to be used by viewport code!

Definition at line 871 of file gpu_framebuffer.cc.

References GPUOffScreen::color.

Referenced by blender::gpu::tests::blend_test(), pygpu_offscreen_color_texture_get(), pygpu_offscreen_texture_color_get(), blender::gpu::tests::vertex_buffer_fetch_mode(), wm_draw_offscreen_texture_parameters(), wm_draw_region_texture(), and wm_draw_window().

GPU_offscreen_create()

GPUOffScreen * GPU_offscreen_create	(	int	width,
		int	height,
		bool	with_depth_buffer,
		eGPUTextureFormat	format,
		eGPUTextureUsage	usage,
		bool	clear,
		char	err_out[256] )

Create a GPUOffScreen with attachment size of width by height pixels. If with_depth_buffer is true, a depth buffer attachment will also be created. format is the format of the color buffer. If clear is true, the color and depth buffer attachments will be cleared. If err_out is not nullptr it will be use to write any configuration error message..

Note

This function binds the framebuffer to the active context.

GPU_TEXTURE_USAGE_ATTACHMENT is added to the usage parameter by default.

Definition at line 728 of file gpu_framebuffer.cc.

References BLI_strncpy(), clear(), GPUOffScreen::color, GPUOffScreen::depth, error(), fb(), GPU_DEPTH24_STENCIL8, GPU_framebuffer_bind(), GPU_framebuffer_check_valid(), GPU_framebuffer_clear_color(), GPU_framebuffer_clear_color_depth(), GPU_framebuffer_restore(), gpu_offscreen_fb_get(), GPU_offscreen_free(), GPU_texture_create_2d(), GPU_TEXTURE_USAGE_ATTACHMENT, GPU_TEXTURE_USAGE_FORMAT_VIEW, max_ii(), and MEM_callocN().

Referenced by blender::gpu::tests::blend_test(), ED_view3d_draw_offscreen_imbuf(), blender::ed::greasepencil::image_render::image_render_begin(), pygpu_offscreen__tp_new(), screen_opengl_render_init(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::vertex_buffer_fetch_mode(), wm_draw_region_buffer_create(), wm_draw_window(), WM_window_pixels_read_from_offscreen(), WM_window_pixels_read_sample_from_offscreen(), and wm_xr_session_surface_offscreen_ensure().

GPU_offscreen_draw_to_screen()

void GPU_offscreen_draw_to_screen	(	GPUOffScreen *	offscreen,
		int	x,
		int	y )

Blit the offscreen color texture to the active framebuffer at the (x, y) location.

Definition at line 832 of file gpu_framebuffer.cc.

References blender::gpu::Context::active_fb, blender::gpu::FrameBuffer::blit_to(), blender::gpu::Context::get(), GPU_COLOR_BIT, gpu_offscreen_fb_get(), blender::gpu::unwrap(), x, and y.

Referenced by wm_draw_region_blit().

GPU_offscreen_format()

eGPUTextureFormat GPU_offscreen_format

(

const GPUOffScreen *

offscreen

)

Return the texture format of a GPUOffScreen.

Definition at line 876 of file gpu_framebuffer.cc.

References GPUOffScreen::color, and GPU_texture_format().

Referenced by ED_view3d_draw_offscreen_imbuf(), and wm_draw_region_buffer_create().

GPU_offscreen_free()

void GPU_offscreen_free

(

GPUOffScreen *

offscreen

)

Free a GPUOffScreen.

Definition at line 791 of file gpu_framebuffer.cc.

References GPUOffScreen::color, GPUOffScreen::depth, GPUOffScreen::framebuffers, GPU_framebuffer_free(), GPU_texture_free(), and MEM_freeN().

Referenced by blender::gpu::tests::blend_test(), BPyGPUOffScreen__tp_dealloc(), ED_view3d_draw_offscreen_imbuf(), GPU_offscreen_create(), blender::ed::greasepencil::image_render::image_render_end(), pygpu_offscreen_free(), screen_opengl_render_end(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::vertex_buffer_fetch_mode(), wm_draw_region_buffer_free(), wm_draw_window(), WM_window_pixels_read_from_offscreen(), WM_window_pixels_read_sample_from_offscreen(), wm_xr_session_surface_free_data(), and wm_xr_session_surface_offscreen_ensure().

GPU_offscreen_height()

int GPU_offscreen_height

(

const GPUOffScreen *

offscreen

)

Return the height of a GPUOffScreen.

Definition at line 866 of file gpu_framebuffer.cc.

References GPUOffScreen::color, and GPU_texture_height().

Referenced by ED_view3d_draw_offscreen_imbuf(), GPU_viewport_bind_from_offscreen(), blender::ed::greasepencil::image_render::image_render_end(), pygpu_offscreen_draw_view3d(), pygpu_offscreen_height_get(), wm_draw_region_buffer_create(), and wm_xr_session_surface_offscreen_ensure().

GPU_offscreen_read_color()

void GPU_offscreen_read_color	(	GPUOffScreen *	offscreen,
		eGPUDataFormat	data_format,
		void *	r_data )

Read the whole color texture of the a GPUOffScreen. The pixel data will be converted to data_format but it needs to be compatible with the attachment type. IMPORTANT: r_data must be big enough for all pixels in data_format.

Definition at line 851 of file gpu_framebuffer.cc.

References BLI_assert, GPUOffScreen::color, ELEM, GPU_DATA_FLOAT, GPU_DATA_UBYTE, GPU_offscreen_read_color_region(), GPU_texture_height(), GPU_texture_width(), and w().

Referenced by blender::gpu::tests::blend_test(), ED_view3d_draw_offscreen_imbuf(), blender::ed::greasepencil::image_render::image_render_end(), screen_opengl_render_doit(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::vertex_buffer_fetch_mode(), and WM_window_pixels_read_from_offscreen().

GPU_offscreen_read_color_region()

void GPU_offscreen_read_color_region	(	GPUOffScreen *	offscreen,
		eGPUDataFormat	data_format,
		int	x,
		int	y,
		int	w,
		int	h,
		void *	r_data )

A version of GPU_offscreen_read_color that reads into a region.

Definition at line 839 of file gpu_framebuffer.cc.

References BLI_assert, GPUOffScreen::color, ELEM, GPU_DATA_FLOAT, GPU_DATA_UBYTE, GPU_framebuffer_read_color(), gpu_offscreen_fb_get(), GPU_texture_height(), GPU_texture_width(), w(), x, and y.

Referenced by GPU_offscreen_read_color(), and WM_window_pixels_read_sample_from_offscreen().

GPU_offscreen_unbind()

void GPU_offscreen_unbind	(	GPUOffScreen *	offscreen,
		bool	restore )

Unbind a GPUOffScreen from a #GPUContext. If restore is true, it will restore the previously bound framebuffer. If false, it will bind the window back-buffer.

Definition at line 817 of file gpu_framebuffer.cc.

References fb(), GPU_framebuffer_bind(), GPU_framebuffer_pop(), and GPU_framebuffer_restore().

Referenced by blender::gpu::tests::blend_test(), ED_view3d_draw_offscreen_imbuf(), blender::ed::greasepencil::image_render::image_render_end(), pygpu_offscreen_draw_view3d(), pygpu_offscreen_stack_context_exit(), pygpu_offscreen_unbind(), screen_opengl_render_doit(), blender::gpu::tests::test_immediate_one_plane(), blender::gpu::tests::test_immediate_two_planes(), blender::gpu::tests::vertex_buffer_fetch_mode(), wm_draw_region_unbind(), wm_draw_window(), WM_window_pixels_read_from_offscreen(), and WM_window_pixels_read_sample_from_offscreen().

GPU_offscreen_viewport_data_get()

void GPU_offscreen_viewport_data_get	(	GPUOffScreen *	offscreen,
		GPUFrameBuffer **	r_fb,
		GPUTexture **	r_color,
		GPUTexture **	r_depth )

Return the internals of a GPUOffScreen. Does not give ownership.

Note

only to be used by viewport code!

Definition at line 881 of file gpu_framebuffer.cc.

References GPUOffScreen::color, GPUOffScreen::depth, and gpu_offscreen_fb_get().

Referenced by GPU_viewport_bind_from_offscreen().

GPU_offscreen_width()

int GPU_offscreen_width

(

const GPUOffScreen *

offscreen

)

Return the width of a GPUOffScreen.

Definition at line 861 of file gpu_framebuffer.cc.

References GPUOffScreen::color, and GPU_texture_width().

Referenced by ED_view3d_draw_offscreen_imbuf(), GPU_viewport_bind_from_offscreen(), blender::ed::greasepencil::image_render::image_render_end(), pygpu_offscreen_draw_view3d(), pygpu_offscreen_width_get(), wm_draw_region_buffer_create(), and wm_xr_session_surface_offscreen_ensure().

Variable Documentation

GPU_MAX_VIEWPORTS

int GPU_MAX_VIEWPORTS = 16

staticconstexpr

Definition at line 41 of file GPU_framebuffer.hh.

Referenced by blender::gpu::GLFrameBuffer::apply_state(), blender::gpu::MTLFrameBuffer::apply_state(), blender::gpu::MTLContext::ensure_render_pipeline_state(), GPU_framebuffer_multi_viewports_set(), blender::gpu::MTLContext::pipeline_state_init(), blender::gpu::MTLContext::set_viewports(), blender::gpu::FrameBuffer::viewport_multi_set(), blender::gpu::VKFrameBuffer::vk_render_areas_append(), and blender::gpu::VKFrameBuffer::vk_viewports_append().