Blender  V2.93
Classes | Typedefs | Functions
GPU_viewport.h File Reference
#include <stdbool.h>
#include "DNA_scene_types.h"
#include "DNA_vec_types.h"
#include "GPU_framebuffer.h"

Go to the source code of this file.

Classes

struct  ViewportMemoryPool
 
struct  FramebufferList
 
struct  TextureList
 
struct  PassList
 
struct  StorageList
 
struct  ViewportEngineData
 
struct  ViewportEngineData_Info
 

Typedefs

typedef struct GHash GHash
 
typedef struct GPUViewport GPUViewport
 
typedef struct ViewportMemoryPool ViewportMemoryPool
 
typedef struct FramebufferList FramebufferList
 
typedef struct TextureList TextureList
 
typedef struct PassList PassList
 
typedef struct StorageList StorageList
 
typedef struct ViewportEngineData ViewportEngineData
 
typedef struct ViewportEngineData_Info ViewportEngineData_Info
 

Functions

GPUViewport * GPU_viewport_create (void)
 
GPUViewport * GPU_viewport_stereo_create (void)
 
void GPU_viewport_bind (GPUViewport *viewport, int view, const rcti *rect)
 
void GPU_viewport_unbind (GPUViewport *viewport)
 
void GPU_viewport_draw_to_screen (GPUViewport *viewport, int view, const rcti *rect)
 
void GPU_viewport_draw_to_screen_ex (GPUViewport *viewport, int view, const rcti *rect, bool display_colorspace, bool do_overlay_merge)
 
void GPU_viewport_free (GPUViewport *viewport)
 
void GPU_viewport_colorspace_set (GPUViewport *viewport, ColorManagedViewSettings *view_settings, ColorManagedDisplaySettings *display_settings, float dither)
 
void GPU_viewport_bind_from_offscreen (GPUViewport *viewport, struct GPUOffScreen *ofs)
 
void GPU_viewport_unbind_from_offscreen (GPUViewport *viewport, struct GPUOffScreen *ofs, bool display_colorspace, bool do_overlay_merge)
 
ViewportMemoryPool * GPU_viewport_mempool_get (GPUViewport *viewport)
 
struct DRWInstanceDataList * GPU_viewport_instance_data_list_get (GPUViewport *viewport)
 
void * GPU_viewport_engine_data_create (GPUViewport *viewport, void *engine_type)
 
void * GPU_viewport_engine_data_get (GPUViewport *viewport, void *engine_handle)
 
void * GPU_viewport_framebuffer_list_get (GPUViewport *viewport)
 
void GPU_viewport_stereo_composite (GPUViewport *viewport, Stereo3dFormat *stereo_format)
 
void * GPU_viewport_texture_list_get (GPUViewport *viewport)
 
void GPU_viewport_size_get (const GPUViewport *viewport, int size[2])
 
void GPU_viewport_size_set (GPUViewport *viewport, const int size[2])
 
void GPU_viewport_active_view_set (GPUViewport *viewport, int view)
 
double * GPU_viewport_cache_time_get (GPUViewport *viewport)
 
void GPU_viewport_tag_update (GPUViewport *viewport)
 
bool GPU_viewport_do_update (GPUViewport *viewport)
 
GPUTexture * GPU_viewport_color_texture (GPUViewport *viewport, int view)
 
GPUTexture * GPU_viewport_texture_pool_query (GPUViewport *viewport, void *engine, int width, int height, int format)
 
bool GPU_viewport_engines_data_validate (GPUViewport *viewport, void **engine_handle_array)
 
void GPU_viewport_cache_release (GPUViewport *viewport)
 
struct GPUFrameBuffer * GPU_viewport_framebuffer_default_get (GPUViewport *viewport)
 
struct GPUFrameBuffer * GPU_viewport_framebuffer_overlay_get (GPUViewport *viewport)
 

Typedef Documentation

◆ FramebufferList

◆ GHash

typedef struct GHash GHash

Definition at line 1 of file GPU_viewport.h.

◆ GPUViewport

typedef struct GPUViewport GPUViewport

Definition at line 1 of file GPU_viewport.h.

◆ PassList

typedef struct PassList PassList

◆ StorageList

typedef struct StorageList StorageList

◆ TextureList

typedef struct TextureList TextureList

◆ ViewportEngineData

◆ ViewportEngineData_Info

◆ ViewportMemoryPool

Function Documentation

◆ GPU_viewport_active_view_set()

void GPU_viewport_active_view_set ( GPUViewport *  viewport,
int  view 
)

Definition at line 321 of file gpu_viewport.c.

References gpu_viewport_framebuffer_view_set(), and view.

Referenced by DRW_notify_view_update().

◆ GPU_viewport_bind()

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

◆ GPU_viewport_bind_from_offscreen()

void GPU_viewport_bind_from_offscreen ( GPUViewport *  viewport,
struct GPUOffScreen *  ofs 
)

◆ GPU_viewport_cache_release()

void GPU_viewport_cache_release ( GPUViewport *  viewport)

◆ GPU_viewport_cache_time_get()

double* GPU_viewport_cache_time_get ( GPUViewport *  viewport)

◆ GPU_viewport_color_texture()

GPUTexture* GPU_viewport_color_texture ( GPUViewport *  viewport,
int  view 
)

◆ GPU_viewport_colorspace_set()

void GPU_viewport_colorspace_set ( GPUViewport *  viewport,
ColorManagedViewSettings *  view_settings,
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 T75443). 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 557 of file gpu_viewport.c.

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

Referenced by drw_viewport_colormanagement_set().

◆ GPU_viewport_create()

GPUViewport* GPU_viewport_create ( void  )

◆ GPU_viewport_do_update()

bool GPU_viewport_do_update ( GPUViewport *  viewport)

Definition at line 137 of file gpu_viewport.c.

References DO_UPDATE, GPUViewport::flag, and ret.

Referenced by wm_region_test_render_do_draw().

◆ 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
rectCoordinates to draw into. By swapping min and max values, drawing can be done with inversed axis coordinates (upside down or sideways).

Definition at line 867 of file gpu_viewport.c.

References GPU_viewport_draw_to_screen_ex(), and view.

Referenced by 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 
)

◆ GPU_viewport_engine_data_create()

void* GPU_viewport_engine_data_create ( GPUViewport *  viewport,
void *  engine_type 
)

◆ GPU_viewport_engine_data_get()

void* GPU_viewport_engine_data_get ( GPUViewport *  viewport,
void *  engine_handle 
)

◆ GPU_viewport_engines_data_validate()

bool GPU_viewport_engines_data_validate ( GPUViewport *  viewport,
void **  engine_handle_array 
)

◆ GPU_viewport_framebuffer_default_get()

struct GPUFrameBuffer* GPU_viewport_framebuffer_default_get ( GPUViewport *  viewport)

◆ GPU_viewport_framebuffer_list_get()

void* GPU_viewport_framebuffer_list_get ( GPUViewport *  viewport)

◆ GPU_viewport_framebuffer_overlay_get()

struct GPUFrameBuffer* GPU_viewport_framebuffer_overlay_get ( GPUViewport *  viewport)

◆ GPU_viewport_free()

void GPU_viewport_free ( GPUViewport *  viewport)

◆ GPU_viewport_instance_data_list_get()

struct DRWInstanceDataList* GPU_viewport_instance_data_list_get ( GPUViewport *  viewport)

Definition at line 311 of file gpu_viewport.c.

References GPUViewport::idatalist.

Referenced by drw_viewport_var_init().

◆ GPU_viewport_mempool_get()

ViewportMemoryPool* GPU_viewport_mempool_get ( GPUViewport *  viewport)

Definition at line 306 of file gpu_viewport.c.

References GPUViewport::vmempool.

Referenced by drw_viewport_var_init().

◆ GPU_viewport_size_get()

void GPU_viewport_size_get ( const GPUViewport *  viewport,
int  size[2] 
)

Definition at line 336 of file gpu_viewport.c.

References copy_v2_v2_int(), size(), and GPUViewport::size.

Referenced by drw_viewport_var_init().

◆ GPU_viewport_size_set()

void GPU_viewport_size_set ( GPUViewport *  viewport,
const int  size[2] 
)

Special case, this is needed for when we have a viewport without a frame-buffer output (occlusion queries for eg) but still need to set the size since it may be used for other calculations.

Definition at line 346 of file gpu_viewport.c.

References copy_v2_v2_int(), size(), and GPUViewport::size.

Referenced by DRW_custom_pipeline(), DRW_draw_select_loop(), DRW_render_gpencil(), and DRW_render_to_image().

◆ GPU_viewport_stereo_composite()

void GPU_viewport_stereo_composite ( GPUViewport *  viewport,
Stereo3dFormat *  stereo_format 
)

◆ GPU_viewport_stereo_create()

GPUViewport* GPU_viewport_stereo_create ( void  )

◆ GPU_viewport_tag_update()

void GPU_viewport_tag_update ( GPUViewport *  viewport)

Definition at line 132 of file gpu_viewport.c.

References DO_UPDATE, and GPUViewport::flag.

Referenced by DRW_viewport_request_redraw().

◆ GPU_viewport_texture_list_get()

void* GPU_viewport_texture_list_get ( GPUViewport *  viewport)

Definition at line 331 of file gpu_viewport.c.

References GPUViewport::txl.

Referenced by DRW_viewport_texture_list_get(), and view3d_opengl_read_Z_pixels().

◆ GPU_viewport_texture_pool_query()

GPUTexture* GPU_viewport_texture_pool_query ( GPUViewport *  viewport,
void *  engine,
int  width,
int  height,
int  format 
)

◆ GPU_viewport_unbind()

void GPU_viewport_unbind ( GPUViewport *  viewport)

◆ GPU_viewport_unbind_from_offscreen()

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