Blender V4.3
Public Member Functions | Protected Member Functions | Friends | List of all members
blender::gpu::VKTexture Class Reference

#include <vk_texture.hh>

Inherits blender::gpu::Texture.

Public Member Functions

 VKTexture (const char *name)
 
virtual ~VKTexture () override
 
void init (VkImage vk_image, VkImageLayout layout, eGPUTextureFormat texture_format)
 
void generate_mipmap () override
 
void copy_to (Texture *tex) override
 
void copy_to (VKTexture &dst_texture, VkImageAspectFlags vk_image_aspect)
 
void clear (eGPUDataFormat format, const void *data) override
 
void clear_depth_stencil (const eGPUFrameBufferBits buffer, float clear_depth, uint clear_stencil)
 
void swizzle_set (const char swizzle_mask[4]) override
 
void mip_range_set (int min, int max) override
 
void * read (int mip, eGPUDataFormat format) override
 
void read_sub (int mip, eGPUDataFormat format, const int region[6], IndexRange layers, void *r_data)
 
void update_sub (int mip, int offset[3], int extent[3], eGPUDataFormat format, const void *data) override
 
void update_sub (int offset[3], int extent[3], eGPUDataFormat format, GPUPixelBuffer *pixbuf) override
 
uint gl_bindcode_get () const override
 
VkImage vk_image_handle () const
 
eGPUTextureFormat device_format_get () const
 
- Public Member Functions inherited from blender::gpu::Texture
int width_get () const
 
int height_get () const
 
int depth_get () const
 
eGPUTextureUsage usage_get () const
 
void mip_size_get (int mip, int r_size[3]) const
 
int mip_width_get (int mip) const
 
int mip_height_get (int mip) const
 
int mip_depth_get (int mip) const
 
int dimensions_count () const
 
int layer_count () const
 
int mip_count () const
 
eGPUTextureFormat format_get () const
 
eGPUTextureFormatFlag format_flag_get () const
 
eGPUTextureType type_get () const
 
GPUAttachmentType attachment_type (int slot) const
 
 Texture (const char *name)
 
virtual ~Texture ()
 
bool init_1D (int w, int layers, int mip_len, eGPUTextureFormat format)
 
bool init_2D (int w, int h, int layers, int mip_len, eGPUTextureFormat format)
 
bool init_3D (int w, int h, int d, int mip_len, eGPUTextureFormat format)
 
bool init_cubemap (int w, int layers, int mip_len, eGPUTextureFormat format)
 
bool init_buffer (VertBuf *vbo, eGPUTextureFormat format)
 
bool init_view (GPUTexture *src, eGPUTextureFormat format, eGPUTextureType type, int mip_start, int mip_len, int layer_start, int layer_len, bool cube_as_array, bool use_stencil)
 
void usage_set (eGPUTextureUsage usage_flags)
 
void attach_to (FrameBuffer *fb, GPUAttachmentType type)
 
void detach_from (FrameBuffer *fb)
 
void update (eGPUDataFormat format, const void *data)
 

Protected Member Functions

bool init_internal () override
 
bool init_internal (VertBuf *vbo) override
 
bool init_internal (GPUTexture *src, int mip_offset, int layer_offset, bool use_stencil) override
 

Friends

class VKDescriptorSetTracker
 

Image Views

const VKImageView & image_view_get (const VKImageViewInfo &info)
 
const VKImageView & image_view_get (VKImageViewArrayed arrayed)
 

Additional Inherited Members

- Public Attributes inherited from blender::gpu::Texture
GPUSamplerState sampler_state = GPUSamplerState::default_sampler()
 
int refcount = 1
 
int src_w = 0
 
int src_h = 0
 
void ** py_ref = nullptr
 
- Protected Attributes inherited from blender::gpu::Texture
int w_
 
int h_
 
int d_
 
eGPUTextureFormat format_
 
eGPUTextureFormatFlag format_flag_
 
eGPUTextureType type_
 
eGPUTextureUsage gpu_image_usage_flags_
 
int mipmaps_ = -1
 
int mip_min_ = 0
 
int mip_max_ = 0
 
char name_ [DEBUG_NAME_LEN]
 
GPUAttachmentType fb_attachment_ [GPU_TEX_MAX_FBO_ATTACHED]
 
FrameBuffer * fb_ [GPU_TEX_MAX_FBO_ATTACHED]
 

Detailed Description

Definition at line 22 of file vk_texture.hh.

Constructor & Destructor Documentation

◆ VKTexture()

blender::gpu::VKTexture::VKTexture ( const char * name)
inline

Definition at line 71 of file vk_texture.hh.

◆ ~VKTexture()

blender::gpu::VKTexture::~VKTexture ( )
overridevirtual

Definition at line 42 of file vk_texture.cc.

References blender::gpu::VKBackend::device, blender::gpu::VKDiscardPool::discard_image(), blender::gpu::VKDevice::discard_pool_for_current_thread(), and blender::gpu::VKBackend::get().

Member Function Documentation

◆ clear()

void blender::gpu::VKTexture::clear ( eGPUDataFormat format,
const void * data )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 121 of file vk_texture.cc.

References blender::gpu::VKContext::get(), blender::IndexRange::size(), blender::IndexRange::start(), blender::gpu::to_vk_clear_color_value(), blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::render_graph::VKClearColorImageData::vk_clear_color_value, blender::gpu::render_graph::VKClearColorImageData::vk_image, vk_image_handle(), and blender::gpu::render_graph::VKClearColorImageData::vk_image_subresource_range.

◆ clear_depth_stencil()

void blender::gpu::VKTexture::clear_depth_stencil ( const eGPUFrameBufferBits buffer,
float clear_depth,
uint clear_stencil )

Definition at line 141 of file vk_texture.cc.

References BLI_assert, buffers, device_format_get(), blender::gpu::VKContext::get(), GPU_DEPTH_BIT, GPU_STENCIL_BIT, blender::gpu::render_graph::VKClearDepthStencilImageCreateInfo::node_data, blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::render_graph::VKClearDepthStencilImageData::vk_clear_depth_stencil_value, blender::gpu::render_graph::VKClearDepthStencilImageData::vk_image, blender::gpu::render_graph::VKClearDepthStencilImageCreateInfo::vk_image_aspects, vk_image_handle(), and blender::gpu::render_graph::VKClearDepthStencilImageData::vk_image_subresource_range.

Referenced by blender::gpu::VKFrameBuffer::clear().

◆ copy_to() [1/2]

void blender::gpu::VKTexture::copy_to ( Texture * tex)
overridevirtual

Implements blender::gpu::Texture.

Definition at line 108 of file vk_texture.cc.

References BLI_assert, copy_to(), blender::gpu::Texture::d_, blender::gpu::Texture::h_, tex, blender::gpu::to_vk_image_aspect_flag_bits(), UNUSED_VARS_NDEBUG, blender::gpu::unwrap(), and blender::gpu::Texture::w_.

Referenced by blender::gpu::blit_aspect(), and copy_to().

◆ copy_to() [2/2]

void blender::gpu::VKTexture::copy_to ( VKTexture & dst_texture,
VkImageAspectFlags vk_image_aspect )

Definition at line 90 of file vk_texture.cc.

References device_format_get(), blender::gpu::render_graph::VKCopyImageData::dst_image, blender::gpu::VKContext::get(), blender::gpu::render_graph::VKCopyImageCreateInfo::node_data, blender::gpu::render_graph::VKCopyImageData::region, blender::gpu::render_graph::VKCopyImageData::src_image, blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::render_graph::VKCopyImageCreateInfo::vk_image_aspect, and vk_image_handle().

◆ device_format_get()

eGPUTextureFormat blender::gpu::VKTexture::device_format_get ( ) const
inline

Get the texture format how the texture is stored on the device.

Definition at line 111 of file vk_texture.hh.

Referenced by blender::gpu::blit_aspect(), clear_depth_stencil(), copy_to(), and blender::gpu::VKFrameBuffer::rendering_ensure().

◆ generate_mipmap()

void blender::gpu::VKTexture::generate_mipmap ( )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 60 of file vk_texture.cc.

References BLI_assert, ELEM, blender::gpu::Texture::format_flag_, blender::gpu::VKContext::get(), blender::gpu::GPU_FORMAT_COMPRESSED, blender::gpu::GPU_TEXTURE_1D_ARRAY, blender::gpu::GPU_TEXTURE_2D_ARRAY, blender::gpu::render_graph::VKUpdateMipmapsData::l0_size, blender::gpu::render_graph::VKUpdateMipmapsData::layer_count, blender::gpu::Texture::mip_size_get(), blender::gpu::render_graph::VKUpdateMipmapsData::mipmaps, blender::gpu::Texture::mipmaps_, blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::Texture::type_get(), blender::gpu::render_graph::VKUpdateMipmapsData::vk_image, blender::gpu::render_graph::VKUpdateMipmapsData::vk_image_aspect, and vk_image_handle().

◆ gl_bindcode_get()

uint blender::gpu::VKTexture::gl_bindcode_get ( ) const
overridevirtual

Implements blender::gpu::Texture.

Definition at line 326 of file vk_texture.cc.

◆ image_view_get() [1/2]

const VKImageView & blender::gpu::VKTexture::image_view_get ( const VKImageViewInfo & info)

Get a specific image view for this texture. The specification of the image view are passed inside the info parameter.

Definition at line 566 of file vk_texture.cc.

References blender::gpu::VKImageViewInfo::arrayed, image_view_get(), and blender::gpu::Texture::name_.

Referenced by image_view_get(), image_view_get(), and blender::gpu::VKFrameBuffer::rendering_ensure().

◆ image_view_get() [2/2]

const VKImageView & blender::gpu::VKTexture::image_view_get ( VKImageViewArrayed arrayed)

Get the current image view for this texture.

Definition at line 583 of file vk_texture.cc.

References blender::gpu::VKImageViewInfo::arrayed, ELEM, blender::gpu::GPU_TEXTURE_CUBE, blender::gpu::GPU_TEXTURE_CUBE_ARRAY, image_view_get(), blender::gpu::VKImageViewInfo::layer_range, blender::gpu::VKImageViewInfo::mip_range, blender::gpu::NOT_ARRAYED, blender::IndexRange::slice(), blender::gpu::Texture::type_, blender::gpu::VKImageViewInfo::use_srgb, and blender::gpu::VKImageViewInfo::use_stencil.

◆ init()

void blender::gpu::VKTexture::init ( VkImage vk_image,
VkImageLayout layout,
eGPUTextureFormat texture_format )

Definition at line 52 of file vk_texture.cc.

References blender::gpu::Texture::format_.

◆ init_internal() [1/3]

bool blender::gpu::VKTexture::init_internal ( )
overrideprotectedvirtual

Implements blender::gpu::Texture.

Definition at line 333 of file vk_texture.cc.

References blender::gpu::VKBackend::device, blender::gpu::Texture::format_, blender::gpu::VKBackend::get(), GPU_DEPTH24_STENCIL8, GPU_DEPTH32F_STENCIL8, GPU_DEPTH_COMPONENT24, GPU_DEPTH_COMPONENT32F, GPU_RGB16F, GPU_RGB32F, GPU_RGBA16F, GPU_RGBA32F, mip_range_set(), blender::gpu::Texture::mipmaps_, blender::gpu::VKWorkarounds::not_aligned_pixel_formats, and blender::gpu::VKDevice::workarounds_get().

◆ init_internal() [2/3]

bool blender::gpu::VKTexture::init_internal ( GPUTexture * src,
int mip_offset,
int layer_offset,
bool use_stencil )
overrideprotectedvirtual

Implements blender::gpu::Texture.

Definition at line 369 of file vk_texture.cc.

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

◆ init_internal() [3/3]

bool blender::gpu::VKTexture::init_internal ( VertBuf * vbo)
overrideprotectedvirtual

Implements blender::gpu::Texture.

Definition at line 361 of file vk_texture.cc.

References BLI_assert, blender::gpu::Texture::format_, and blender::gpu::unwrap().

◆ mip_range_set()

void blender::gpu::VKTexture::mip_range_set ( int min,
int max )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 175 of file vk_texture.cc.

References max, min, blender::gpu::Texture::mip_max_, and blender::gpu::Texture::mip_min_.

Referenced by init_internal().

◆ read()

void * blender::gpu::VKTexture::read ( int mip,
eGPUDataFormat format )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 217 of file vk_texture.cc.

References BLI_assert, data, blender::gpu::Texture::format_, blender::gpu::Texture::format_flag_, blender::gpu::GPU_FORMAT_COMPRESSED, MEM_mallocN, blender::gpu::Texture::mip_size_get(), read_sub(), blender::gpu::to_bytesize(), blender::gpu::to_vk_image_type(), and blender::gpu::Texture::type_.

◆ read_sub()

void blender::gpu::VKTexture::read_sub ( int mip,
eGPUDataFormat format,
const int region[6],
IndexRange layers,
void * r_data )

Definition at line 181 of file vk_texture.cc.

References blender::gpu::convert_device_to_host(), blender::gpu::VKBuffer::create(), blender::gpu::render_graph::VKCopyImageToBufferData::dst_buffer, blender::gpu::Texture::format_, blender::gpu::VKContext::get(), GPU_USAGE_DYNAMIC, blender::gpu::VKBuffer::mapped_memory_get(), blender::gpu::render_graph::VKCopyImageToBufferData::region, blender::gpu::render_graph::VKCopyImageToBufferData::src_image, blender::gpu::to_bytesize(), blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::to_vk_image_aspect_single_bit(), blender::gpu::VKBuffer::vk_handle(), and vk_image_handle().

Referenced by read().

◆ swizzle_set()

void blender::gpu::VKTexture::swizzle_set ( const char swizzle_mask[4])
overridevirtual

Implements blender::gpu::Texture.

Definition at line 170 of file vk_texture.cc.

References blender::gpu::VKImageViewInfo::swizzle.

◆ update_sub() [1/2]

void blender::gpu::VKTexture::update_sub ( int mip,
int offset[3],
int extent[3],
eGPUDataFormat format,
const void * data )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 250 of file vk_texture.cc.

References BLI_assert, BLI_assert_msg, blender::gpu::convert_host_to_device(), blender::gpu::VKBuffer::create(), divide_ceil_u(), blender::gpu::render_graph::VKCopyBufferToImageData::dst_image, blender::gpu::Texture::format_, blender::gpu::Texture::format_flag_, blender::gpu::VKContext::get(), blender::gpu::GPU_FORMAT_COMPRESSED, blender::gpu::GPU_TEXTURE_1D, blender::gpu::GPU_TEXTURE_2D, blender::gpu::GPU_TEXTURE_CUBE, GPU_USAGE_DYNAMIC, blender::gpu::VKBuffer::mapped_memory_get(), max_ii(), blender::gpu::render_graph::VKCopyBufferToImageData::region, blender::gpu::render_graph::VKCopyBufferToImageData::src_buffer, blender::gpu::to_block_size(), blender::gpu::to_bytesize(), blender::gpu::to_vk_image_aspect_flag_bits(), blender::gpu::to_vk_image_aspect_single_bit(), blender::gpu::Texture::type_, blender::gpu::VKBuffer::vk_handle(), and vk_image_handle().

Referenced by update_sub().

◆ update_sub() [2/2]

void blender::gpu::VKTexture::update_sub ( int offset[3],
int extent[3],
eGPUDataFormat format,
GPUPixelBuffer * pixbuf )
overridevirtual

Implements blender::gpu::Texture.

Definition at line 317 of file vk_texture.cc.

References blender::gpu::VKPixelBuffer::map(), blender::gpu::unwrap(), and update_sub().

◆ vk_image_handle()

VkImage blender::gpu::VKTexture::vk_image_handle ( ) const
inline

Definition at line 99 of file vk_texture.hh.

References BLI_assert, and vk_image_handle().

Referenced by blender::gpu::blit_aspect(), clear(), clear_depth_stencil(), copy_to(), generate_mipmap(), read_sub(), blender::gpu::VKFrameBuffer::rendering_ensure(), update_sub(), and vk_image_handle().

Friends And Related Symbol Documentation

◆ VKDescriptorSetTracker

friend class VKDescriptorSetTracker
friend

Definition at line 23 of file vk_texture.hh.

The documentation for this class was generated from the following files:
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0