Blender V4.5
Namespaces
gpu_texture.cc File Reference
Blender » GPU
#include "BLI_string.h"
#include "GPU_framebuffer.hh"
#include "GPU_texture.hh"
#include "gpu_backend.hh"
#include "gpu_context_private.hh"
#include "gpu_framebuffer_private.hh"
#include "gpu_texture_private.hh"

Go to the source code of this file.

Namespaces

namespace  blender
namespace  blender::gpu

Functions

C-API
uint GPU_texture_memory_usage_get ()
static GPUTexture * gpu_texture_create (const char *name, const int w, const int h, const int d, const eGPUTextureType type, int mip_len, eGPUTextureFormat tex_format, eGPUTextureUsage usage, const void *pixels, eGPUDataFormat data_format=GPU_DATA_FLOAT)
GPUTexture * GPU_texture_create_1d (const char *name, int width, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_1d_array (const char *name, int width, int layer_len, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_2d (const char *name, int width, int height, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_2d_array (const char *name, int width, int height, int layer_len, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_3d (const char *name, int width, int height, int depth, int mip_len, eGPUTextureFormat texture_format, eGPUTextureUsage usage, const void *data)
GPUTexture * GPU_texture_create_cube (const char *name, int width, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_cube_array (const char *name, int width, int layer_len, int mip_len, eGPUTextureFormat format, eGPUTextureUsage usage, const float *data)
GPUTexture * GPU_texture_create_compressed_2d (const char *name, int width, int height, int mip_len, eGPUTextureFormat tex_format, eGPUTextureUsage usage, const void *data)
GPUTexture * GPU_texture_create_from_vertbuf (const char *name, blender::gpu::VertBuf *vert)
GPUTexture * GPU_texture_create_error (int dimension, bool is_array)
GPUTexture * GPU_texture_create_view (const char *name, GPUTexture *source_texture, eGPUTextureFormat view_format, int mip_start, int mip_len, int layer_start, int layer_len, bool cube_as_array, bool use_stencil)
eGPUTextureUsage GPU_texture_usage (const GPUTexture *texture_)
void GPU_texture_update_mipmap (GPUTexture *texture, int mip_level, eGPUDataFormat data_format, const void *pixels)
void GPU_texture_update_sub (GPUTexture *tex, eGPUDataFormat data_format, const void *pixels, int offset_x, int offset_y, int offset_z, int width, int height, int depth)
void GPU_texture_update_sub_from_pixel_buffer (GPUTexture *texture, eGPUDataFormat data_format, GPUPixelBuffer *pixel_buf, int offset_x, int offset_y, int offset_z, int width, int height, int depth)
void * GPU_texture_read (GPUTexture *texture, eGPUDataFormat data_format, int mip_level)
void GPU_texture_clear (GPUTexture *tex, eGPUDataFormat data_format, const void *data)
void GPU_texture_update (GPUTexture *tex, eGPUDataFormat data_format, const void *data)
void GPU_unpack_row_length_set (uint len)
void GPU_texture_bind_ex (GPUTexture *texture, GPUSamplerState state, int unit)
void GPU_texture_bind (GPUTexture *texture, int unit)
void GPU_texture_unbind (GPUTexture *texture)
void GPU_texture_unbind_all ()
void GPU_texture_image_bind (GPUTexture *tex, int unit)
void GPU_texture_image_unbind (GPUTexture *tex)
void GPU_texture_image_unbind_all ()
void GPU_texture_update_mipmap_chain (GPUTexture *tex)
void GPU_texture_copy (GPUTexture *dst_, GPUTexture *src_)
void GPU_texture_compare_mode (GPUTexture *texture, bool use_compare)
void GPU_texture_filter_mode (GPUTexture *texture, bool use_filter)
void GPU_texture_mipmap_mode (GPUTexture *texture, bool use_mipmap, bool use_filter)
void GPU_texture_anisotropic_filter (GPUTexture *texture, bool use_aniso)
void GPU_texture_extend_mode_x (GPUTexture *texture, GPUSamplerExtendMode extend_mode)
void GPU_texture_extend_mode_y (GPUTexture *texture, GPUSamplerExtendMode extend_mode)
void GPU_texture_extend_mode (GPUTexture *texture, GPUSamplerExtendMode extend_mode)
void GPU_texture_swizzle_set (GPUTexture *texture, const char swizzle[4])
void GPU_texture_free (GPUTexture *texture)
void GPU_texture_ref (GPUTexture *texture)
int GPU_texture_dimensions (const GPUTexture *texture)
int GPU_texture_width (const GPUTexture *texture)
int GPU_texture_height (const GPUTexture *texture)
int GPU_texture_depth (const GPUTexture *texture)
int GPU_texture_layer_count (const GPUTexture *texture)
int GPU_texture_mip_count (const GPUTexture *texture)
int GPU_texture_original_width (const GPUTexture *texture)
int GPU_texture_original_height (const GPUTexture *texture)
void GPU_texture_original_size_set (GPUTexture *texture, int w, int h)
eGPUTextureFormat GPU_texture_format (const GPUTexture *texture)
const char * GPU_texture_format_name (eGPUTextureFormat texture_format)
bool GPU_texture_has_depth_format (const GPUTexture *texture)
bool GPU_texture_has_stencil_format (const GPUTexture *texture)
bool GPU_texture_has_integer_format (const GPUTexture *texture)
bool GPU_texture_has_float_format (const GPUTexture *texture)
bool GPU_texture_has_normalized_format (const GPUTexture *texture)
bool GPU_texture_has_signed_format (const GPUTexture *texture)
bool GPU_texture_is_cube (const GPUTexture *texture)
bool GPU_texture_is_array (const GPUTexture *texture)
void ** GPU_texture_py_reference_get (GPUTexture *texture)
void GPU_texture_py_reference_set (GPUTexture *texture, void **py_ref)
int GPU_texture_opengl_bindcode (const GPUTexture *texture)
void GPU_texture_get_mipmap_size (GPUTexture *texture, int mip_level, int *r_size)
GPU Pixel Buffer

Pixel buffer utility functions.

GPUPixelBuffer * GPU_pixel_buffer_create (size_t size)
void GPU_pixel_buffer_free (GPUPixelBuffer *pixel_buf)
void * GPU_pixel_buffer_map (GPUPixelBuffer *pixel_buf)
void GPU_pixel_buffer_unmap (GPUPixelBuffer *pixel_buf)
size_t GPU_pixel_buffer_size (GPUPixelBuffer *pixel_buf)
GPUPixelBufferNativeHandle GPU_pixel_buffer_get_native_handle (GPUPixelBuffer *pixel_buf)
GPU Sampler Objects

Simple wrapper around opengl sampler objects. Override texture sampler state for one sampler unit only.

void GPU_samplers_update ()
GPU texture utilities
size_t GPU_texture_component_len (eGPUTextureFormat tex_format)
size_t GPU_texture_dataformat_size (eGPUDataFormat data_format)

Function Documentation

◆ GPU_pixel_buffer_create()

GPUPixelBuffer * GPU_pixel_buffer_create ( size_t byte_size)

Creates a #GPUPixelBuffer object with byte_size worth of storage.

Definition at line 968 of file gpu_texture.cc.

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

Referenced by DisplayGPUPixelBuffer::gpu_resources_ensure().

◆ GPU_pixel_buffer_free()

void GPU_pixel_buffer_free ( GPUPixelBuffer * pixel_buf)

Free a #GPUPixelBuffer object. The object should be unmapped before being freed.

Definition at line 981 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by DisplayGPUPixelBuffer::gpu_resources_destroy().

◆ GPU_pixel_buffer_get_native_handle()

GPUPixelBufferNativeHandle GPU_pixel_buffer_get_native_handle ( GPUPixelBuffer * pixel_buf)

Definition at line 1002 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by BlenderDisplayDriver::graphics_interop_update_buffer(), and blender::gpu::GLTexture::update_sub().

◆ GPU_pixel_buffer_map()

void * GPU_pixel_buffer_map ( GPUPixelBuffer * pixel_buf)

Maps a pixel buffer to RAM, giving back access rights to CPU. The returned pointer is only valid until GPU_pixel_buffer_unmap is called. A #GPUPixelBuffer needs to be unmapped before being used for GPU side operation (like texture update through GPU_texture_update_sub_from_pixel_buffer).

Definition at line 987 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by BlenderDisplayDriver::map_texture_buffer().

◆ GPU_pixel_buffer_size()

size_t GPU_pixel_buffer_size ( GPUPixelBuffer * pixel_buf)

Return size in bytes of the pix_buf.

Definition at line 997 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by DisplayGPUPixelBuffer::gpu_resources_ensure().

◆ GPU_pixel_buffer_unmap()

void GPU_pixel_buffer_unmap ( GPUPixelBuffer * pixel_buf)

Unmap a pixel buffer from RAM, giving back access rights to GPU. Any pointer previously acquired by GPU_pixel_buffer_map becomes invalid.

Definition at line 992 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by BlenderDisplayDriver::unmap_texture_buffer().

◆ GPU_samplers_update()

void GPU_samplers_update ( )

Update sampler states depending on user settings.

Definition at line 1016 of file gpu_texture.cc.

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

◆ GPU_texture_anisotropic_filter()

void GPU_texture_anisotropic_filter ( GPUTexture * texture,
bool use_aniso )

Set anisotropic filter usage. Filter sample count is determined globally by U.anisotropic_filter and updated when GPU_samplers_update is called.

Definition at line 639 of file gpu_texture.cc.

References BLI_assert, blender::gpu::Texture::format_flag_get(), blender::gpu::GPU_FORMAT_INTEGER, blender::gpu::GPU_FORMAT_STENCIL, GPU_SAMPLER_FILTERING_ANISOTROPIC, blender::gpu::Texture::sampler_state, GPUSamplerState::set_filtering_flag_from_test(), texture(), and blender::gpu::unwrap().

Referenced by blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_gpu(), blender::nodes::node_composite_displace_cc::DisplaceOperation::execute_gpu(), blender::nodes::node_composite_map_uv_cc::MapUVOperation::execute_gpu(), IMB_create_gpu_texture(), and IMB_touch_gpu_texture().

◆ GPU_texture_bind()

void GPU_texture_bind ( GPUTexture * texture,
int unit )

Bind a texture to a texture sampling image units using the texture internal sampler state.

Definition at line 565 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::Texture::sampler_state, blender::gpu::Context::state_manager, texture(), blender::gpu::StateManager::texture_bind(), and blender::gpu::unwrap().

Referenced by blender::compositor::SMAAPrecomputedTextures::bind_area_texture(), blender::compositor::Result::bind_as_texture(), blender::gpu::GLVertBuf::bind_as_texture(), blender::gpu::MTLVertBuf::bind_as_texture(), blender::compositor::SMAAPrecomputedTextures::bind_search_texture(), blender::render::hydra::DrawTexture::draw(), draw_display_buffer(), blender::ed::vse::ThumbsDrawBatch::flush_batch(), gpu_viewport_draw_colormanaged(), GPU_viewport_stereo_composite(), immBindTexture(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), blender::compositor::parallel_reduction_dispatch(), blender::ed::vse::preview_draw_texture_simple(), blender::ed::vse::preview_draw_texture_to_linear(), pygpu_shader_uniform_sampler(), blender::ed::vse::sequencer_draw_scopes(), wm_draw_region_blend(), and wm_draw_window().

◆ GPU_texture_bind_ex()

void GPU_texture_bind_ex ( GPUTexture * texture,
GPUSamplerState state,
int unit )

Bind a texture to a texture sampling image units using the explicit sampler state.

Definition at line 558 of file gpu_texture.cc.

References blender::gpu::Context::get(), GPU_SAMPLER_STATE_TYPE_INTERNAL, blender::gpu::Texture::sampler_state, state, blender::gpu::Context::state_manager, texture(), blender::gpu::StateManager::texture_bind(), and blender::gpu::unwrap().

Referenced by draw_tile(), blender::draw::command::ResourceBind::execute(), immBindTextureSampler(), and blender::gpu::GLFrameBuffer::subpass_transition_impl().

◆ GPU_texture_clear()

void GPU_texture_clear ( GPUTexture * texture,
eGPUDataFormat data_format,
const void * data )

Fills the whole texture with the same data for all pixels.

Warning
Only works for 2D and 3D textures.
Only clears the MIP 0 of the texture.
Parameters
data_formatdata format of the pixel data.
Note
The format is float for UNORM textures.
Parameters
data1 pixel worth of data to fill the texture with.

Definition at line 540 of file gpu_texture.cc.

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

Referenced by blender::nodes::node_composite_glare_cc::GlareOperation::accumulate_ghosts_gpu(), blender::gpu::tests::blend_test(), blender::draw::Texture::clear(), blender::draw::Texture::clear(), blender::draw::Texture::clear(), blender::nodes::node_composite_base_cryptomatte_cc::BaseCryptoMatteOperation::compute_matte_gpu(), blender::nodes::node_composite_composite_cc::CompositeOperation::execute_clear(), blender::nodes::node_composite_viewer_cc::ViewerOperation::execute_clear(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_streaks(), gpu_viewport_textures_create(), pygpu_texture_clear(), blender::gpu::tests::test_compute_indirect(), blender::gpu::tests::test_texture_1d(), blender::gpu::tests::test_texture_1d_array(), blender::gpu::tests::test_texture_2d_array(), blender::gpu::tests::test_texture_3d(), blender::gpu::tests::test_texture_copy(), blender::gpu::tests::test_texture_cube(), blender::gpu::tests::test_texture_cube_array(), blender::gpu::tests::test_texture_read(), blender::gpu::tests::test_texture_update_sub_no_unpack_row_length(), blender::gpu::tests::test_texture_update_sub_unpack_row_length(), and blender::gpu::tests::vertex_buffer_fetch_mode().

◆ GPU_texture_compare_mode()

void GPU_texture_compare_mode ( GPUTexture * texture,
bool use_compare )

Set tex texture depth comparison mode. Only works on depth format.

Definition at line 609 of file gpu_texture.cc.

References BLI_assert, GPUSamplerState::custom_type, blender::gpu::Texture::format_flag_get(), blender::gpu::GPU_FORMAT_DEPTH, GPU_SAMPLER_CUSTOM_COMPARE, GPU_SAMPLER_STATE_TYPE_CUSTOM, GPU_SAMPLER_STATE_TYPE_PARAMETERS, blender::gpu::Texture::sampler_state, texture(), GPUSamplerState::type, and blender::gpu::unwrap().

◆ GPU_texture_component_len()

size_t GPU_texture_component_len ( eGPUTextureFormat format)

Returns the number of components in a texture format.

Definition at line 1031 of file gpu_texture.cc.

References blender::gpu::to_component_len().

Referenced by blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_pass_for_result(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_view_for_result(), blender::nodes::node_composite_denoise_cc::DenoiseOperation::execute(), pygpu_texture__tp_new(), and pygpu_texture_read().

◆ GPU_texture_copy()

void GPU_texture_copy ( GPUTexture * dst,
GPUTexture * src )

Copy a src texture content to a similar dst texture. Only MIP 0 is copied. Textures needs to match in size and format.

Definition at line 602 of file gpu_texture.cc.

References blender::gpu::Texture::copy_to(), and blender::gpu::unwrap().

Referenced by blender::nodes::node_composite_glare_cc::GlareOperation::accumulate_ghosts_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::apply_streak_filter_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_bloom_downsample_chain(), blender::draw::overlay::Wireframe::copy_depth(), blender::workbench::AntiAliasingPass::draw(), blender::workbench::OpaquePass::draw(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_bloom(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_anti_diagonal_pass_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_diagonal_pass_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_horizontal_pass_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_simple_star_vertical_pass_gpu(), ViewportColorSampleSession::init(), blender::eevee::DeferredLayer::render(), and blender::gpu::tests::test_texture_copy().

◆ gpu_texture_create()

GPUTexture * gpu_texture_create ( const char * name,
const int w,
const int h,
const int d,
const eGPUTextureType type,
int mip_len,
eGPUTextureFormat tex_format,
eGPUTextureUsage usage,
const void * pixels,
eGPUDataFormat data_format = GPU_DATA_FLOAT )
inlinestatic

Definition at line 256 of file gpu_texture.cc.

References BLI_assert, blender::gpu::GPUBackend::get(), GPU_DATA_FLOAT, blender::gpu::GPU_TEXTURE_1D, blender::gpu::GPU_TEXTURE_1D_ARRAY, blender::gpu::GPU_TEXTURE_2D, blender::gpu::GPU_TEXTURE_2D_ARRAY, blender::gpu::GPU_TEXTURE_3D, blender::gpu::GPU_TEXTURE_CUBE, blender::gpu::GPU_TEXTURE_CUBE_ARRAY, blender::gpu::Texture::init_1D(), blender::gpu::Texture::init_2D(), blender::gpu::Texture::init_3D(), blender::gpu::Texture::init_cubemap(), blender::gpu::GPUBackend::texture_alloc(), blender::gpu::Texture::update(), blender::gpu::Texture::usage_set(), and w().

Referenced by GPU_texture_create_1d(), GPU_texture_create_1d_array(), GPU_texture_create_2d(), GPU_texture_create_2d_array(), GPU_texture_create_3d(), GPU_texture_create_cube(), GPU_texture_create_cube_array(), and GPU_texture_create_error().

◆ GPU_texture_create_1d()

GPUTexture * GPU_texture_create_1d ( const char * name,
int width,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )
Note
data is expected to be float. If the format is not compatible with float data or if the data is not in float format, use GPU_texture_update to upload the data with the right data format.

Textures created via other means will either inherit usage from the source resource, or also be initialized with GPU_TEXTURE_USAGE_GENERAL.

flag. mips is the number of mip level to allocate. It must be >= 1.

Definition at line 302 of file gpu_texture.cc.

References data, blender::gpu::GPU_TEXTURE_1D, and gpu_texture_create().

Referenced by blender::gpu::MTLContext::get_dummy_texture(), blender::ocio::internal::GPUCurveMappping::initialize_common(), pygpu_texture__tp_new(), blender::gpu::tests::test_shader_compute_1d(), and blender::gpu::tests::test_texture_1d().

◆ GPU_texture_create_1d_array()

GPUTexture * GPU_texture_create_1d_array ( const char * name,
int width,
int layer_len,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )

Definition at line 312 of file gpu_texture.cc.

References data, blender::gpu::GPU_TEXTURE_1D_ARRAY, and gpu_texture_create().

Referenced by blender::gpu::MTLContext::get_dummy_texture(), gpu_material_ramp_texture_build(), gpu_texture_create_tile_mapping(), pygpu_texture__tp_new(), blender::gpu::tests::test_texture_1d_array(), and blender::gpu::tests::test_texture_1d_array_upload().

◆ GPU_texture_create_2d()

GPUTexture * GPU_texture_create_2d ( const char * name,
int width,
int height,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )

Definition at line 324 of file gpu_texture.cc.

References data, blender::gpu::GPU_TEXTURE_2D, and gpu_texture_create().

Referenced by blender::gpu::TexturePool::acquire_texture(), blender::render::hydra::GPURenderTaskDelegate::add_aov(), blf_glyph_draw(), blender::render::hydra::DrawTexture::create_from_buffer(), blender::ed::vse::create_texture(), draw_display_buffer(), draw_plane_marker_image(), draw_select_framebuffer_depth_only_setup(), blender::ed::vse::draw_strip_thumbnails(), blender::draw::overlay::Instance::end_sync(), blender::gpu::MTLContext::get_dummy_texture(), GPU_offscreen_create(), DisplayGPUTexture::gpu_resources_ensure(), blender::gpu::tests::gpu_shader_lib_test(), gpu_viewport_textures_create(), IMB_create_gpu_texture(), IMB_touch_gpu_texture(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), ViewportColorSampleSession::init(), blender::ed::sculpt_paint::load_tex(), blender::ed::sculpt_paint::load_tex_cursor(), pygpu_texture__tp_new(), radial_control_set_tex(), RE_pass_ensure_gpu_texture_cache(), blender::ed::vse::sequencer_draw_scopes(), studiolight_create_equirect_radiance_gputexture(), studiolight_create_matcap_gputexture(), blender::gpu::VKContext::sync_backbuffer(), blender::gpu::tests::test_compute_direct(), blender::gpu::tests::test_compute_indirect(), 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_scissor_test(), blender::gpu::tests::test_framebuffer_subpass_input(), blender::gpu::tests::test_shader_compute_2d(), blender::gpu::tests::test_texture_copy(), blender::gpu::tests::test_texture_read(), blender::gpu::tests::test_texture_update_sub_no_unpack_row_length(), blender::gpu::tests::test_texture_update_sub_unpack_row_length(), blender::gpu::tests::texture_create_upload_read(), blender::gpu::tests::texture_create_upload_read_pixel(), blender::gpu::tests::texture_create_upload_read_with_bias(), wm_software_cursor_draw_bitmap(), and workbench_render_framebuffers_init().

◆ GPU_texture_create_2d_array()

GPUTexture * GPU_texture_create_2d_array ( const char * name,
int width,
int height,
int layer_len,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )

Definition at line 335 of file gpu_texture.cc.

References data, blender::gpu::GPU_TEXTURE_2D_ARRAY, and gpu_texture_create().

Referenced by blender::gpu::MTLContext::get_dummy_texture(), gpu_material_sky_texture_build(), IMB_touch_gpu_texture(), pygpu_texture__tp_new(), blender::gpu::tests::test_framebuffer_multi_viewport(), blender::gpu::tests::test_texture_2d_array(), and blender::gpu::tests::test_texture_2d_array_upload().

◆ GPU_texture_create_3d()

GPUTexture * GPU_texture_create_3d ( const char * name,
int width,
int height,
int depth,
int mip_len,
eGPUTextureFormat texture_format,
eGPUTextureUsage usage,
const void * data )

Definition at line 348 of file gpu_texture.cc.

References data, blender::gpu::GPU_TEXTURE_3D, and gpu_texture_create().

Referenced by DRW_smoke_ensure_velocity(), blender::gpu::MTLContext::get_dummy_texture(), pygpu_texture__tp_new(), blender::gpu::tests::test_texture_3d(), and blender::draw::volume_grid_cache_get().

◆ GPU_texture_create_compressed_2d()

GPUTexture * GPU_texture_create_compressed_2d ( const char * name,
int width,
int height,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const void * data )

DDS texture loading. Return nullptr if compressed texture support is not available. data should hold all the data for mip_len mipmaps. The data is expected to be in compressed form. This isn't going to compress un-compress data.

Definition at line 383 of file gpu_texture.cc.

References data, blender::gpu::GPUBackend::get(), blender::gpu::Texture::init_2D(), blender::gpu::Texture::mip_size_get(), size(), blender::gpu::GPUBackend::texture_alloc(), blender::gpu::to_block_size(), blender::gpu::to_data_format(), blender::gpu::Texture::update_sub(), and blender::gpu::Texture::usage_set().

Referenced by IMB_create_gpu_texture().

◆ GPU_texture_create_cube()

GPUTexture * GPU_texture_create_cube ( const char * name,
int width,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )

Definition at line 361 of file gpu_texture.cc.

References data, gpu_texture_create(), and blender::gpu::GPU_TEXTURE_CUBE.

Referenced by blender::gpu::MTLContext::get_dummy_texture(), pygpu_texture__tp_new(), blender::gpu::tests::test_framebuffer_cube(), and blender::gpu::tests::test_texture_cube().

◆ GPU_texture_create_cube_array()

GPUTexture * GPU_texture_create_cube_array ( const char * name,
int width,
int layer_len,
int mip_len,
eGPUTextureFormat format,
eGPUTextureUsage usage,
const float * data )

Definition at line 371 of file gpu_texture.cc.

References data, gpu_texture_create(), and blender::gpu::GPU_TEXTURE_CUBE_ARRAY.

Referenced by blender::gpu::MTLContext::get_dummy_texture(), pygpu_texture__tp_new(), and blender::gpu::tests::test_texture_cube_array().

◆ GPU_texture_create_error()

GPUTexture * GPU_texture_create_error ( int dimension,
bool array )

Create an error texture that will bind an pink texture at draw time. dimension is the number of number of dimension of the texture (1, 2, or 3). array if set to true, will make the texture be an array (layered).

Definition at line 434 of file gpu_texture.cc.

References GPU_RGBA8, blender::gpu::GPU_TEXTURE_1D, blender::gpu::GPU_TEXTURE_1D_ARRAY, blender::gpu::GPU_TEXTURE_2D, blender::gpu::GPU_TEXTURE_2D_ARRAY, blender::gpu::GPU_TEXTURE_3D, gpu_texture_create(), GPU_TEXTURE_USAGE_GENERAL, and w().

Referenced by BKE_movieclip_get_gpu_texture(), image_gpu_texture_error_create(), and blender::ocio::internal::GPUTextures::initialize_common().

◆ GPU_texture_create_from_vertbuf()

GPUTexture * GPU_texture_create_from_vertbuf ( const char * name,
blender::gpu::VertBuf * vertex_buf )

Create a buffer texture that allow access to a buffer vertex_buf through a sampler of type (FLOAT/INT/UINT)_BUFFER.

Definition at line 414 of file gpu_texture.cc.

References BLI_assert_msg, blender::gpu::VertBuf::extended_usage_, blender::gpu::GPUBackend::get(), GPU_USAGE_FLAG_BUFFER_TEXTURE_ONLY, GPU_vertbuf_get_format(), blender::gpu::Texture::init_buffer(), blender::gpu::GPUBackend::texture_alloc(), and blender::gpu::to_texture_format().

Referenced by blender::gpu::GLVertBuf::bind_as_texture(), blender::gpu::MTLVertBuf::bind_as_texture(), blender::gpu::MTLContext::get_dummy_texture(), and blender::draw::particle_batch_cache_ensure_procedural_strand_data().

◆ GPU_texture_create_view()

GPUTexture * GPU_texture_create_view ( const char * name,
GPUTexture * source_texture,
eGPUTextureFormat view_format,
int mip_start,
int mip_len,
int layer_start,
int layer_len,
bool cube_as_array,
bool use_stencil )

Create an alias of the source texture data. A view can cover the whole texture or only a range of mip levels and/or array layer range.

view_format is the format in which the view will interpret the data of source_texture. It must match the format of source_texture in size (ex: RGBA8 can be reinterpreted as R32UI). See https://www.khronos.org/opengl/wiki/Texture_Storage#View_texture_aliases for an exhaustive list.

Note
If source_texture is freed, the texture view will continue to be valid.
If mip_start or mip_len is bigger than available mips they will be clamped to the source texture available range.
If cube_as_array is true, then the created view will be a 2D array texture instead of a cube-map texture or cube-map-array texture.

For Depth-Stencil texture view formats:

Note
If use_stencil is true, the texture is expected to be bound to a UINT sampler and will return the stencil value (in a range of [0..255]) as the first component.
If use_stencil is false (default), the texture is expected to be bound to a DEPTH sampler and will return the normalized depth value (in a range of [0..1]) as the first component.

TODO(fclem): Target conversion (ex: Texture 2D as Texture 2D Array) is not implemented yet.

Definition at line 449 of file gpu_texture.cc.

References BLI_assert, BLI_assert_msg, blender::gpu::GPUBackend::get(), GPU_texture_format(), GPU_texture_usage(), GPU_TEXTURE_USAGE_FORMAT_VIEW, blender::gpu::GPUBackend::texture_alloc(), blender::gpu::unwrap(), view, and blender::gpu::wrap().

Referenced by blender::draw::Texture::ensure_layer_views(), blender::draw::Texture::ensure_mip_views(), blender::draw::Texture::layer_range_view(), and blender::draw::Texture::stencil_view().

◆ GPU_texture_dataformat_size()

size_t GPU_texture_dataformat_size ( eGPUDataFormat data_format)

Return the expected number of bytes for one pixel of data_format data.

Definition at line 1036 of file gpu_texture.cc.

References blender::gpu::to_bytesize().

Referenced by pygpu_buffer__bf_getbuffer(), pygpu_buffer__sq_item(), pygpu_buffer_calc_size(), pygpu_buffer_strides_calc(), pygpu_framebuffer_read_color(), and pygpu_framebuffer_read_depth().

◆ GPU_texture_depth()

int GPU_texture_depth ( const GPUTexture * texture)

Return the depth of tex . Correspond to number of layers for 2D array texture. NOTE: return 0 for 1D & 2D textures.

Definition at line 717 of file gpu_texture.cc.

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

Referenced by blender::draw::Texture::depth().

◆ GPU_texture_dimensions()

int GPU_texture_dimensions ( const GPUTexture * texture)

Return the number of dimensions of the texture ignoring dimension of layers (1, 2 or 3). Cube textures are considered 2D.

Definition at line 688 of file gpu_texture.cc.

References blender::gpu::GPU_TEXTURE_1D, blender::gpu::GPU_TEXTURE_2D, blender::gpu::GPU_TEXTURE_3D, blender::gpu::GPU_TEXTURE_CUBE, texture(), and blender::gpu::unwrap().

Referenced by blender::ocio::GPUShaderBinder::create_gpu_shader(), and blender::draw::Texture::debug_clear().

◆ GPU_texture_extend_mode()

void GPU_texture_extend_mode ( GPUTexture * texture,
GPUSamplerExtendMode extend_mode )

Set tex texture sampling method for coordinates outside of the [0..1] uv range along both the x and y axis. See GPUSamplerExtendMode for the available and meaning of different extend modes.

Definition at line 658 of file gpu_texture.cc.

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

Referenced by blender::nodes::node_composite_glare_cc::GlareOperation::apply_streak_filter_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_base_ghost_gpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_gpu(), blender::ed::vse::draw_strip_thumbnails(), blender::nodes::node_composite_directionalblur_cc::DirectionalBlurOperation::execute_gpu(), blender::nodes::node_composite_displace_cc::DisplaceOperation::execute_gpu(), blender::nodes::node_composite_map_uv_cc::MapUVOperation::execute_gpu(), blender::nodes::node_composite_moviedistortion_cc::MovieDistortionOperation::execute_gpu(), blender::nodes::node_composite_sunbeams_cc::SunBeamsOperation::execute_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_horizontal_distortion_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_radial_distortion_gpu(), blender::nodes::node_composite_scale_cc::ScaleOperation::execute_variable_size_gpu(), DisplayGPUTexture::gpu_resources_ensure(), blender::compositor::horizontal_pass_gpu(), image_get_gpu_texture(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), blender::ocio::internal::GPUCurveMappping::initialize_common(), blender::ed::vse::sequencer_draw_scopes(), studiolight_create_equirect_radiance_gputexture(), blender::compositor::vertical_pass_gpu(), blender::draw::volume_grid_cache_get(), blender::draw::VolumeModule::VolumeModule(), blender::nodes::node_composite_glare_cc::GlareOperation::write_glare_output_gpu(), and blender::nodes::node_composite_glare_cc::GlareOperation::write_highlights_output_gpu().

◆ GPU_texture_extend_mode_x()

void GPU_texture_extend_mode_x ( GPUTexture * texture,
GPUSamplerExtendMode extend_mode )

Set tex texture sampling method for coordinates outside of the [0..1] uv range along the x axis. See GPUSamplerExtendMode for the available and meaning of different extend modes.

Definition at line 648 of file gpu_texture.cc.

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

◆ GPU_texture_extend_mode_y()

void GPU_texture_extend_mode_y ( GPUTexture * texture,
GPUSamplerExtendMode extend_mode )

Set tex texture sampling method for coordinates outside of the [0..1] uv range along the y axis. See GPUSamplerExtendMode for the available and meaning of different extend modes.

Definition at line 653 of file gpu_texture.cc.

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

◆ GPU_texture_filter_mode()

void GPU_texture_filter_mode ( GPUTexture * texture,
bool use_filter )

Set tex texture filter usage. If use_filter is true, the texture will use linear interpolation between neighboring texels.

Note
Does not work on non-normalized integer textures.
Does not modify the mip-map usage state.

Definition at line 620 of file gpu_texture.cc.

References BLI_assert, blender::gpu::Texture::format_flag_get(), blender::gpu::GPU_FORMAT_INTEGER, blender::gpu::GPU_FORMAT_STENCIL, GPU_SAMPLER_FILTERING_LINEAR, blender::gpu::Texture::sampler_state, GPUSamplerState::set_filtering_flag_from_test(), texture(), and blender::gpu::unwrap().

Referenced by blender::workbench::AntiAliasingPass::AntiAliasingPass(), blender::nodes::node_composite_glare_cc::GlareOperation::apply_streak_filter_gpu(), blender::compositor::blend_neighborhood_gpu(), blender::compositor::calculate_blending_weights_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_base_ghost_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_bloom_downsample_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::compute_bloom_upsample_gpu(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_gpu(), blender::ed::vse::create_texture(), blender::compositor::detect_edges_gpu(), draw_display_buffer(), draw_plane_marker_image(), blender::ed::vse::draw_strip_thumbnails(), blender::nodes::node_composite_defocus_cc::DefocusOperation::execute_gpu(), blender::nodes::node_composite_directionalblur_cc::DirectionalBlurOperation::execute_gpu(), blender::nodes::node_composite_moviedistortion_cc::MovieDistortionOperation::execute_gpu(), blender::nodes::node_composite_sunbeams_cc::SunBeamsOperation::execute_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_highlights_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_horizontal_distortion_gpu(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_mix_gpu(), blender::nodes::node_composite_lensdist_cc::LensDistortionOperation::execute_radial_distortion_gpu(), blender::nodes::node_composite_scale_cc::ScaleOperation::execute_variable_size_gpu(), blender::draw::Texture::filter_mode(), DisplayGPUTexture::gpu_resources_ensure(), blender::compositor::horizontal_pass_gpu(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), blender::ocio::internal::GPUCurveMappping::initialize_common(), radial_control_set_tex(), blender::ed::vse::sequencer_draw_scopes(), studiolight_create_equirect_radiance_gputexture(), blender::compositor::vertical_pass_gpu(), wm_software_cursor_draw_bitmap(), blender::nodes::node_composite_glare_cc::GlareOperation::write_glare_output_gpu(), and blender::nodes::node_composite_glare_cc::GlareOperation::write_highlights_output_gpu().

◆ GPU_texture_format()

eGPUTextureFormat GPU_texture_format ( const GPUTexture * texture)

Return the texture format of tex.

Definition at line 748 of file gpu_texture.cc.

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

Referenced by blender::gpu::TexturePool::acquire_texture(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_pass_for_result(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_view_for_result(), blender::render::hydra::DrawTexture::create_from_buffer(), blender::draw::Texture::ensure_layer_views(), blender::draw::Texture::ensure_mip_views(), blender::nodes::node_composite_denoise_cc::DenoiseOperation::execute(), blender::draw::compositor_engine::Context::get_pass(), GPU_framebuffer_blit(), GPU_offscreen_format(), GPU_texture_create_view(), blender::compositor::is_compatible_texture(), blender::draw::Texture::layer_range_view(), pygpu_texture_format_get(), pygpu_texture_read(), blender::draw::Texture::stencil_view(), blender::gpu::tests::test_texture_pool(), blender::gpu::MTLFrameBuffer::update_attachments(), and blender::eevee::Film::write_viewport_compositor_passes().

◆ GPU_texture_format_name()

const char * GPU_texture_format_name ( eGPUTextureFormat format)

Return the texture format as a string for display purpose. Example: GPU_RGBA8 returns as "RGBA8".

Definition at line 753 of file gpu_texture.cc.

References BLI_assert_unreachable, GPU_DEPTH24_STENCIL8, GPU_DEPTH32F_STENCIL8, GPU_DEPTH_COMPONENT16, GPU_DEPTH_COMPONENT24, GPU_DEPTH_COMPONENT32F, GPU_R11F_G11F_B10F, GPU_R16, GPU_R16_SNORM, GPU_R16F, GPU_R16I, GPU_R16UI, GPU_R32F, GPU_R32I, GPU_R32UI, GPU_R8, GPU_R8_SNORM, GPU_R8I, GPU_R8UI, GPU_RG16, GPU_RG16_SNORM, GPU_RG16F, GPU_RG16I, GPU_RG16UI, GPU_RG32F, GPU_RG32I, GPU_RG32UI, GPU_RG8, GPU_RG8_SNORM, GPU_RG8I, GPU_RG8UI, GPU_RGB10_A2, GPU_RGB10_A2UI, GPU_RGB16, GPU_RGB16_SNORM, GPU_RGB16F, GPU_RGB16I, GPU_RGB16UI, GPU_RGB32F, GPU_RGB32I, GPU_RGB32UI, GPU_RGB8, GPU_RGB8_SNORM, GPU_RGB8I, GPU_RGB8UI, GPU_RGB9_E5, GPU_RGBA16, GPU_RGBA16_SNORM, GPU_RGBA16F, GPU_RGBA16I, GPU_RGBA16UI, GPU_RGBA32F, GPU_RGBA32I, GPU_RGBA32UI, GPU_RGBA8, GPU_RGBA8_DXT1, GPU_RGBA8_DXT3, GPU_RGBA8_DXT5, GPU_RGBA8_SNORM, GPU_RGBA8I, GPU_RGBA8UI, GPU_SRGB8, GPU_SRGB8_A8, GPU_SRGB8_A8_DXT1, GPU_SRGB8_A8_DXT3, and GPU_SRGB8_A8_DXT5.

Referenced by uiTemplateImageInfo().

◆ GPU_texture_free()

void GPU_texture_free ( GPUTexture * texture)

This internally decrement the reference counter. If the reference counter is 1 when calling this function the #GPUTexture will be freed.

Definition at line 669 of file gpu_texture.cc.

References blender::gpu::Texture::refcount, texture(), and blender::gpu::unwrap().

Referenced by blender::draw::Manager::begin_sync(), BKE_image_add_tile(), BKE_image_reassign_tile(), BKE_movieclip_free_gputexture(), BKE_previewimg_clear_single(), BKE_previewimg_free(), blf_glyph_draw(), BPyGPUTexture__tp_dealloc(), blender::render::hydra::DrawTexture::create_from_buffer(), draw_display_buffer(), draw_plane_marker_image(), draw_select_framebuffer_depth_only_setup(), blender::ed::vse::draw_strip_thumbnails(), blender::compositor::Result::free(), free_buffers(), blender::gpu::MTLContext::free_dummy_resources(), gpu_free_unused_buffers(), GPU_offscreen_free(), blender::gpu::tests::gpu_shader_lib_test(), icon_preview_endjob(), image_free_gpu(), image_free_tile(), IMB_free_gpu_textures(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), blender::ed::sculpt_paint::load_tex(), blender::ed::sculpt_paint::load_tex_cursor(), paint_cursor_delete_textures(), radial_control_cancel(), blender::gpu::TexturePool::reset(), blender::ed::vse::sequencer_draw_scopes(), blender::ed::vse::sequencer_preview_region_draw(), blender::render::hydra::GPURenderTaskDelegate::set_viewport(), blender::gpu::VKContext::sync_backbuffer(), blender::gpu::tests::test_compute_direct(), blender::gpu::tests::test_compute_indirect(), 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::test_shader_compute_1d(), blender::gpu::tests::test_shader_compute_2d(), blender::gpu::tests::test_texture_1d(), blender::gpu::tests::test_texture_1d_array(), blender::gpu::tests::test_texture_1d_array_upload(), blender::gpu::tests::test_texture_2d_array(), blender::gpu::tests::test_texture_2d_array_upload(), blender::gpu::tests::test_texture_3d(), blender::gpu::tests::test_texture_copy(), blender::gpu::tests::test_texture_cube(), blender::gpu::tests::test_texture_cube_array(), blender::gpu::tests::test_texture_read(), blender::gpu::tests::test_texture_update_sub_no_unpack_row_length(), blender::gpu::tests::test_texture_update_sub_unpack_row_length(), blender::gpu::tests::texture_create_upload_read(), blender::gpu::tests::texture_create_upload_read_pixel(), blender::gpu::tests::texture_create_upload_read_with_bias(), wm_software_cursor_draw_bitmap(), blender::render::Context::~Context(), blender::render::hydra::DrawTexture::~DrawTexture(), GlyphCacheBLF::~GlyphCacheBLF(), blender::ocio::internal::GPUCurveMappping::~GPUCurveMappping(), GPUMaterial::~GPUMaterial(), blender::render::hydra::GPURenderTaskDelegate::~GPURenderTaskDelegate(), blender::ocio::internal::GPUTextures::~GPUTextures(), blender::draw::Manager::~Manager(), blender::gpu::MTLContext::~MTLContext(), blender::gpu::TexturePool::~TexturePool(), ViewportColorSampleSession::~ViewportColorSampleSession(), and blender::gpu::VKContext::~VKContext().

◆ GPU_texture_get_mipmap_size()

void GPU_texture_get_mipmap_size ( GPUTexture * texture,
int mip_level,
int * r_size )

Returns the pixel dimensions of a texture's mip-map level. size is expected to be a pointer to a vector of dimension matching the texture's dimension (including the array dimension).

Definition at line 955 of file gpu_texture.cc.

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

Referenced by blender::workbench::VolumePass::object_sync_volume(), blender::draw::Texture::size(), blender::gpu::MTLFrameBuffer::update_attachments(), and blender::gpu::VKFrameBuffer::update_size().

◆ GPU_texture_has_depth_format()

bool GPU_texture_has_depth_format ( const GPUTexture * texture)

Return true if the texture format has a depth component.

Definition at line 896 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_DEPTH, texture(), and blender::gpu::unwrap().

Referenced by blender::gpu::FrameBuffer::attachment_set(), GPU_framebuffer_blit(), blender::draw::Texture::is_depth(), and pygpu_framebuffer__tp_new().

◆ GPU_texture_has_float_format()

bool GPU_texture_has_float_format ( const GPUTexture * texture)

Return true if the texture format is a float type.

Definition at line 911 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_FLOAT, texture(), and blender::gpu::unwrap().

Referenced by blender::draw::Texture::debug_clear().

◆ GPU_texture_has_integer_format()

bool GPU_texture_has_integer_format ( const GPUTexture * texture)

Return true if the texture format is an integer type (non-normalized integers).

Definition at line 906 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_INTEGER, texture(), and blender::gpu::unwrap().

Referenced by blender::draw::Texture::debug_clear(), and blender::draw::Texture::is_integer().

◆ GPU_texture_has_normalized_format()

bool GPU_texture_has_normalized_format ( const GPUTexture * texture)

Return true if the texture format is an integer normalized type.

Definition at line 916 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_NORMALIZED_INTEGER, texture(), and blender::gpu::unwrap().

Referenced by blender::draw::Texture::debug_clear().

◆ GPU_texture_has_signed_format()

bool GPU_texture_has_signed_format ( const GPUTexture * texture)

Return true if the texture format is a signed type.

Definition at line 921 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_SIGNED, texture(), and blender::gpu::unwrap().

Referenced by blender::draw::Texture::debug_clear().

◆ GPU_texture_has_stencil_format()

bool GPU_texture_has_stencil_format ( const GPUTexture * texture)

Return true if the texture format has a stencil component.

Definition at line 901 of file gpu_texture.cc.

References blender::gpu::GPU_FORMAT_STENCIL, texture(), and blender::gpu::unwrap().

Referenced by blender::gpu::FrameBuffer::attachment_set(), GPU_framebuffer_blit(), GPU_framebuffer_config_array(), and blender::draw::Texture::is_stencil().

◆ GPU_texture_height()

int GPU_texture_height ( const GPUTexture * texture)

Return the height of tex. Correspond to number of layers for 1D array texture.

Definition at line 712 of file gpu_texture.cc.

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

Referenced by blender::eevee::Film::accumulate(), blender::gpu::TexturePool::acquire_texture(), blender::render::hydra::DrawTexture::create_from_buffer(), draw_select_framebuffer_depth_only_setup(), DRW_select_buffer_read(), DRWContext::DRWContext(), GPU_offscreen_height(), GPU_offscreen_read_color(), GPU_offscreen_read_color_region(), gpu_texture_create_tile_mapping(), gpu_texture_update_from_ibuf(), gpu_texture_update_scaled(), GPU_viewport_draw_to_screen_ex(), blender::draw::Texture::height(), blender::eevee::Instance::init(), ViewportColorSampleSession::init(), blender::compositor::parallel_reduction_dispatch(), blender::draw::Texture::pixel_count(), pygpu_texture_height_get(), pygpu_texture_read(), blender::render::hydra::GPURenderTaskDelegate::read_aov(), blender::eevee::Film::read_pass(), blender::eevee::DepthOfField::render(), blender::gpu::tests::test_texture_pool(), view3d_depths_create(), and blender::compositor::Result::wrap_external().

◆ GPU_texture_image_bind()

void GPU_texture_image_bind ( GPUTexture * texture,
int unit )

Bind tex to an arbitrary load/store image unit. It correspond to a gpu::shader::ShaderCreateInfo::image() declaration.

Note
this overrides any previous bind on the same unit.

Definition at line 582 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::StateManager::image_bind(), blender::gpu::Context::state_manager, and blender::gpu::unwrap().

Referenced by blender::compositor::Result::bind_as_image(), blender::draw::command::ResourceBind::execute(), blender::compositor::parallel_reduction_dispatch(), pygpu_shader_image(), blender::gpu::MTLFrameBuffer::subpass_transition_impl(), blender::gpu::tests::test_compute_direct(), blender::gpu::tests::test_compute_indirect(), blender::gpu::tests::test_shader_compute_1d(), and blender::gpu::tests::test_shader_compute_2d().

◆ GPU_texture_image_unbind()

void GPU_texture_image_unbind ( GPUTexture * texture)

Unbind tex from an arbitrary load/store image unit.

Note
this isn't strictly required but it is better for debugging purpose.

Definition at line 587 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::StateManager::image_unbind(), blender::gpu::Context::state_manager, and blender::gpu::unwrap().

Referenced by blender::compositor::parallel_reduction_dispatch(), and blender::compositor::Result::unbind_as_image().

◆ GPU_texture_image_unbind_all()

void GPU_texture_image_unbind_all ( )

Unbind all texture from all arbitrary load/store image units.

Definition at line 592 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::StateManager::image_unbind_all(), and blender::gpu::Context::state_manager.

Referenced by blender::draw::command::RecordingState::cleanup(), blender::compositor::ShaderOperation::execute(), and blender::draw::command::StateSet::set().

◆ GPU_texture_is_array()

bool GPU_texture_is_array ( const GPUTexture * texture)

Return true if the texture is an array texture type (has layers).

Definition at line 931 of file gpu_texture.cc.

References blender::gpu::GPU_TEXTURE_ARRAY, texture(), and blender::gpu::unwrap().

Referenced by blender::gpu::FrameBuffer::attachment_set(), and blender::draw::Texture::is_array().

◆ GPU_texture_is_cube()

bool GPU_texture_is_cube ( const GPUTexture * texture)

Return true if the texture is an cube-map texture type.

Definition at line 926 of file gpu_texture.cc.

References blender::gpu::GPU_TEXTURE_CUBE, texture(), and blender::gpu::unwrap().

Referenced by blender::gpu::FrameBuffer::attachment_set(), and blender::draw::Texture::is_cube().

◆ GPU_texture_layer_count()

int GPU_texture_layer_count ( const GPUTexture * texture)

Return the number of layers of tex. Return 1 if the texture is not layered.

Definition at line 722 of file gpu_texture.cc.

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

Referenced by blender::draw::Texture::ensure_layer_views(), and blender::draw::Texture::layer_range_view().

◆ GPU_texture_memory_usage_get()

uint GPU_texture_memory_usage_get ( )

Returns the memory usage of all currently allocated textures in bytes.

Note
that does not mean all of the textures are inside VRAM. Drivers can swap the texture memory back and forth depending on usage.

Definition at line 248 of file gpu_texture.cc.

◆ GPU_texture_mip_count()

int GPU_texture_mip_count ( const GPUTexture * texture)

Return the number of mip-map level inside this texture.

Definition at line 727 of file gpu_texture.cc.

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

Referenced by blender::draw::Texture::ensure_mip_views(), and blender::draw::Texture::mip_count().

◆ GPU_texture_mipmap_mode()

void GPU_texture_mipmap_mode ( GPUTexture * texture,
bool use_mipmap,
bool use_filter )

Set tex texture filter and mip-map usage. If use_filter is true, the texture will use linear interpolation between neighboring texels. If use_mipmap is true, the texture will use mip-mapping as anti-aliasing method. If both are set to true, the texture will use linear interpolation between mip-map levels.

Note
Does not work on non-normalized integer textures.

Definition at line 629 of file gpu_texture.cc.

References BLI_assert, blender::gpu::Texture::format_flag_get(), blender::gpu::GPU_FORMAT_INTEGER, blender::gpu::GPU_FORMAT_STENCIL, GPU_SAMPLER_FILTERING_LINEAR, GPU_SAMPLER_FILTERING_MIPMAP, blender::gpu::Texture::sampler_state, GPUSamplerState::set_filtering_flag_from_test(), texture(), and blender::gpu::unwrap().

Referenced by BKE_image_paint_set_mipmap(), BKE_movieclip_get_gpu_texture(), blender::nodes::node_composite_cornerpin_cc::CornerPinOperation::compute_plane_gpu(), blender::nodes::node_composite_planetrackdeform_cc::PlaneTrackDeformOperation::compute_plane_gpu(), blender::nodes::node_composite_displace_cc::DisplaceOperation::execute_gpu(), blender::nodes::node_composite_map_uv_cc::MapUVOperation::execute_gpu(), gpu_texture_create_tile_array(), gpu_texture_create_tile_mapping(), image_get_gpu_texture(), immDrawPixelsTexScaledFullSize(), blender::eevee::HiZBuffer::sync(), and wm_draw_offscreen_texture_parameters().

◆ GPU_texture_opengl_bindcode()

int GPU_texture_opengl_bindcode ( const GPUTexture * texture)

Return the backend handle of the texture.

Note
This is a legacy feature only working on OpenGL backend. It will be removed once we remove the python BGL module.

Definition at line 950 of file gpu_texture.cc.

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

Referenced by pygpu_offscreen_color_texture_get().

◆ GPU_texture_original_height()

int GPU_texture_original_height ( const GPUTexture * texture)

Definition at line 737 of file gpu_texture.cc.

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

◆ GPU_texture_original_size_set()

void GPU_texture_original_size_set ( GPUTexture * texture,
int w,
int h )

Definition at line 742 of file gpu_texture.cc.

References texture(), blender::gpu::unwrap(), and w().

Referenced by image_get_gpu_texture().

◆ GPU_texture_original_width()

int GPU_texture_original_width ( const GPUTexture * texture)

Width & Height (of source data), optional. WORKAROUND: Calling BKE_image_get_size may free the texture. Store the source image size (before down-scaling) inside the #GPUTexture to retrieve the original size later (Ref #59347).

Definition at line 732 of file gpu_texture.cc.

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

◆ GPU_texture_py_reference_get()

void ** GPU_texture_py_reference_get ( GPUTexture * texture)

Reference of a pointer that needs to be cleaned when deallocating the texture. Points to BPyGPUTexture.tex

Definition at line 937 of file gpu_texture.cc.

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

Referenced by BPyGPUTexture_CreatePyObject().

◆ GPU_texture_py_reference_set()

void GPU_texture_py_reference_set ( GPUTexture * texture,
void ** py_ref )

Definition at line 942 of file gpu_texture.cc.

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

Referenced by BPyGPUTexture__tp_dealloc(), and BPyGPUTexture_CreatePyObject().

◆ GPU_texture_read()

void * GPU_texture_read ( GPUTexture * texture,
eGPUDataFormat data_format,
int mip_level )

Read the content of a mip_level from a tex and returns a copy of its data.

Warning
the texture must have been created using GPU_TEXTURE_USAGE_HOST_READ.
Note
synchronization of shader writes via imageStore() needs to be explicitly done using GPU_memory_barrier(GPU_BARRIER_TEXTURE_FETCH).

Definition at line 531 of file gpu_texture.cc.

References BLI_assert_msg, GPU_texture_usage(), GPU_TEXTURE_USAGE_HOST_READ, texture(), and blender::gpu::unwrap().

Referenced by blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_pass_for_result(), blender::nodes::node_composite_file_output_cc::FileOutputOperation::add_view_for_result(), blender::compositor::compute_preview_gpu(), blender::nodes::node_composite_denoise_cc::DenoiseOperation::execute(), blender::nodes::node_composite_glare_cc::GlareOperation::execute_fog_glow(), blender::gpu::tests::gpu_shader_lib_test(), ViewportColorSampleSession::init(), blender::render::Context::output_to_render_result(), blender::compositor::parallel_reduction_dispatch(), pygpu_texture_read(), blender::draw::Texture::read(), blender::eevee::Film::read_aov(), blender::render::hydra::GPURenderTaskDelegate::read_aov(), blender::eevee::Film::read_pass(), blender::gpu::tests::test_compute_direct(), blender::gpu::tests::test_compute_indirect(), 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::test_shader_compute_1d(), blender::gpu::tests::test_shader_compute_2d(), blender::gpu::tests::test_texture_1d(), blender::gpu::tests::test_texture_1d_array(), blender::gpu::tests::test_texture_1d_array_upload(), blender::gpu::tests::test_texture_2d_array(), blender::gpu::tests::test_texture_2d_array_upload(), blender::gpu::tests::test_texture_3d(), blender::gpu::tests::test_texture_copy(), blender::gpu::tests::test_texture_cube(), blender::gpu::tests::test_texture_cube_array(), blender::gpu::tests::test_texture_read(), blender::gpu::tests::test_texture_update_sub_no_unpack_row_length(), blender::gpu::tests::test_texture_update_sub_unpack_row_length(), blender::gpu::tests::texture_create_upload_read(), blender::gpu::tests::texture_create_upload_read_pixel(), blender::gpu::tests::texture_create_upload_read_with_bias(), view3d_depths_create(), and blender::render::Context::viewer_output_to_viewer_image().

◆ GPU_texture_ref()

void GPU_texture_ref ( GPUTexture * texture)

Add a reference to this texture for usage. This internally increment the reference counter. This avoids the texture being free between the time it is referenced by the drawing logic and the time it is actually dereferenced.

Definition at line 683 of file gpu_texture.cc.

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

Referenced by blender::draw::Manager::acquire_texture(), BPyGPUTexture_CreatePyObject(), blender::render::Context::get_pass(), and blender::eevee::LookdevWorld::sync().

◆ GPU_texture_swizzle_set()

void GPU_texture_swizzle_set ( GPUTexture * texture,
const char swizzle[4] )

Set tex texture swizzle state for swizzling sample components.

A texture sample always return 4 components in the shader. If the texture has less than 4 components, the missing ones are replaced by the matching values in the following vector (0, 0, 0, 1).

swizzle contains 1 char per component representing the source of the data for each of the component of a sample value. The possible values for each of these 4 characters are:

  • 'r' or 'x': use the texture first component.
  • 'g' or 'y': use the texture second component.
  • 'b' or 'z': use the texture third component.
  • 'a' or 'w': use the texture fourth component.
  • '0': will make the component value to always return 0.
  • '1': will make the component value to always return 1.

Definition at line 664 of file gpu_texture.cc.

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

Referenced by blender::eevee::RenderBuffers::acquire(), blender::compositor::compute_preview_gpu(), IMB_create_gpu_texture(), IMB_touch_gpu_texture(), blender::ed::sculpt_paint::load_tex(), blender::ed::sculpt_paint::load_tex_cursor(), radial_control_set_tex(), blender::eevee::RenderBuffers::release(), and blender::draw::volume_grid_cache_get().

◆ GPU_texture_unbind()

void GPU_texture_unbind ( GPUTexture * texture)

Unbind tex from a texture sampling image unit.

Note
this isn't strictly required but it is better for debugging purpose.

Definition at line 571 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::Context::state_manager, texture(), blender::gpu::StateManager::texture_unbind(), and blender::gpu::unwrap().

Referenced by blf_batch_draw(), draw_display_buffer(), draw_plane_marker_image(), blender::ed::vse::draw_strip_thumbnails(), gpu_texture_update_from_ibuf(), gpu_viewport_draw_colormanaged(), GPU_viewport_stereo_composite(), immDrawPixelsTexScaledFullSize(), immDrawPixelsTexTiled_scaling_clipping(), blender::ed::sculpt_paint::paint_draw_cursor_overlay(), blender::ed::sculpt_paint::paint_draw_tex_overlay(), blender::compositor::parallel_reduction_dispatch(), blender::ed::vse::preview_draw_texture_simple(), blender::ed::vse::preview_draw_texture_to_linear(), radial_control_paint_tex(), blender::ed::vse::sequencer_draw_scopes(), blender::gpu::tests::test_compute_direct(), blender::gpu::tests::test_compute_indirect(), blender::gpu::tests::test_shader_compute_1d(), blender::gpu::tests::test_shader_compute_2d(), blender::compositor::SMAAPrecomputedTextures::unbind_area_texture(), blender::compositor::Result::unbind_as_texture(), blender::compositor::SMAAPrecomputedTextures::unbind_search_texture(), wm_draw_region_blend(), wm_draw_window(), and wm_software_cursor_draw_bitmap().

◆ GPU_texture_unbind_all()

void GPU_texture_unbind_all ( )

Unbind all texture from all texture sampling image units.

Definition at line 577 of file gpu_texture.cc.

References blender::gpu::Context::get(), blender::gpu::Context::state_manager, and blender::gpu::StateManager::texture_unbind_all().

Referenced by blender::draw::command::RecordingState::cleanup(), blender::compositor::ShaderOperation::execute(), blender::draw::command::StateSet::set(), and blender::gpu::MTLContext::~MTLContext().

◆ GPU_texture_update()

void GPU_texture_update ( GPUTexture * texture,
eGPUDataFormat data_format,
const void * data )

Update the content of a texture's base mip-map level (mip 0). data_format is the format of the data . It needs to be compatible with the internal texture storage. The data should be the size of the entire mip 0 level.

Note
This function only update the content of mip 0. Either specify other mips or use GPU_texture_update_mipmap_chain to generate them if needed.

Definition at line 546 of file gpu_texture.cc.

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

Referenced by blender::workbench::AntiAliasingPass::AntiAliasingPass(), blender::compositor::CachedMask::CachedMask(), blender::nodes::node_composite_movieclip_cc::MovieClipOperation::compute_alpha(), blender::nodes::node_composite_movieclip_cc::MovieClipOperation::compute_image(), blender::render::hydra::DrawTexture::create_from_buffer(), blender::ed::vse::create_texture(), blender::compositor::DistortionGrid::DistortionGrid(), draw_display_buffer(), draw_plane_marker_image(), blender::ed::vse::draw_strip_thumbnails(), blender::nodes::node_composite_denoise_cc::DenoiseOperation::execute(), IMB_create_gpu_texture(), immDrawPixelsTexScaledFullSize(), blender::ed::sculpt_paint::load_tex(), blender::ed::sculpt_paint::load_tex_cursor(), blender::compositor::MorphologicalDistanceFeatherWeights::MorphologicalDistanceFeatherWeights(), RE_pass_ensure_gpu_texture_cache(), blender::draw::gpencil::render_init_buffers(), blender::ed::vse::sequencer_draw_scopes(), studiolight_create_matcap_gputexture(), blender::compositor::SymmetricBlurWeights::SymmetricBlurWeights(), blender::compositor::SymmetricSeparableBlurWeights::SymmetricSeparableBlurWeights(), blender::gpu::tests::texture_create_upload_read(), blender::gpu::tests::texture_create_upload_read_pixel(), blender::gpu::tests::texture_create_upload_read_with_bias(), blender::compositor::Result::update_single_value_data(), and wm_software_cursor_draw_bitmap().

◆ GPU_texture_update_mipmap()

void GPU_texture_update_mipmap ( GPUTexture * texture,
int mip_level,
eGPUDataFormat data_format,
const void * pixels )

Update the content of a texture's specific mip-map level. data_format is the format of the pixels . It needs to be compatible with the internal texture storage. The data should be the size of the entire mip_level.

Definition at line 491 of file gpu_texture.cc.

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

Referenced by blender::eevee::UtilityTexture::UtilityTexture().

◆ GPU_texture_update_mipmap_chain()

void GPU_texture_update_mipmap_chain ( GPUTexture * texture)

Update the mip-map levels using the mip 0 data.

Note
this doesn't work on depth or compressed textures.

Definition at line 597 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by blender::compositor::CachedImage::CachedImage(), gpu_texture_create_tile_array(), gpu_texture_update_from_ibuf(), image_get_gpu_texture(), and immDrawPixelsTexScaledFullSize().

◆ GPU_texture_update_sub()

void GPU_texture_update_sub ( GPUTexture * texture,
eGPUDataFormat data_format,
const void * pixels,
int offset_x,
int offset_y,
int offset_z,
int width,
int height,
int depth )

Update the content of a region of a texture's base mip-map level (mip 0). data_format is the format of the data . It needs to be compatible with the internal texture storage. The data should be the size of the mip 0 level region.

Note
This function only update the content of mip 0. Either specify other mips or use GPU_texture_update_mipmap_chain to generate them if needed.

offset_x , offset_y , offset_z specify the bottom left corner of the updated region. width , height , depth specify the extent of the updated region.

Definition at line 501 of file gpu_texture.cc.

References blender::gpu::unwrap().

Referenced by blf_batch_cache_texture_load(), gpu_texture_update_scaled(), gpu_texture_update_unscaled(), IMB_update_gpu_texture_sub(), immDrawPixelsTexTiled_scaling_clipping(), blender::draw::overlay::Instance::init(), blender::draw::gpencil::render_init_buffers(), blender::draw::test_eevee_shadow_tilemap_amend(), blender::gpu::tests::test_texture_update_sub_no_unpack_row_length(), and blender::gpu::tests::test_texture_update_sub_unpack_row_length().

◆ GPU_texture_update_sub_from_pixel_buffer()

void GPU_texture_update_sub_from_pixel_buffer ( GPUTexture * texture,
eGPUDataFormat data_format,
GPUPixelBuffer * pixel_buf,
int offset_x,
int offset_y,
int offset_z,
int width,
int height,
int depth )

Update a sub-region of a texture using the data from a #GPUPixelBuffer as source data. The pix_buf data is expected to be contiguous and big enough to fill the described sub-region.

Definition at line 516 of file gpu_texture.cc.

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

Referenced by update_tile_texture_pixels().

◆ GPU_texture_usage()

eGPUTextureUsage GPU_texture_usage ( const GPUTexture * texture)

Return the usage flags of tex.

Definition at line 483 of file gpu_texture.cc.

References blender::gpu::Texture::usage_get().

Referenced by blender::gpu::TexturePool::acquire_texture(), GPU_texture_create_view(), GPU_texture_read(), and blender::gpu::MTLTexture::init_internal().

◆ GPU_texture_width()

int GPU_texture_width ( const GPUTexture * texture)

Return the width of tex.

Definition at line 707 of file gpu_texture.cc.

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

Referenced by blender::eevee::Film::accumulate(), blender::gpu::TexturePool::acquire_texture(), blf_batch_cache_texture_load(), blf_batch_draw(), blender::render::hydra::DrawTexture::create_from_buffer(), draw_select_framebuffer_depth_only_setup(), DRW_select_buffer_read(), DRWContext::DRWContext(), GPU_offscreen_read_color(), GPU_offscreen_read_color_region(), GPU_offscreen_width(), gpu_texture_create_tile_mapping(), gpu_texture_update_from_ibuf(), gpu_texture_update_scaled(), GPU_viewport_draw_to_screen_ex(), blender::eevee::Instance::init(), ViewportColorSampleSession::init(), blender::compositor::parallel_reduction_dispatch(), blender::draw::Texture::pixel_count(), pygpu_texture_read(), pygpu_texture_width_get(), blender::render::hydra::GPURenderTaskDelegate::read_aov(), blender::eevee::Film::read_pass(), blender::eevee::DepthOfField::render(), blender::gpu::tests::test_texture_pool(), view3d_depths_create(), blender::draw::Texture::width(), and blender::compositor::Result::wrap_external().

◆ GPU_unpack_row_length_set()

void GPU_unpack_row_length_set ( uint len)

Makes data interpretation aware of the source layout. Skipping pixels correctly when changing rows when doing partial update. This affects GPU_texture_update, GPU_texture_update_sub, GPU_texture_update_mipmap. TODO(fclem): replace this by pixel buffer updates using a custom utility to do the line shifting like Cycles does.

Definition at line 551 of file gpu_texture.cc.

References blender::gpu::Context::get(), len, blender::gpu::Context::state_manager, and blender::gpu::StateManager::texture_unpack_row_length_set().

Referenced by gpu_texture_update_unscaled(), immDrawPixelsTexTiled_scaling_clipping(), and blender::gpu::tests::test_texture_update_sub_unpack_row_length().

Generated on for Blender by  doxygen 1.16.1