Blender V5.3
blender::gpu::VKTexture Class Reference

#include <vk_texture.hh>

Inherits blender::gpu::Texture.

Public Member Functions

 VKTexture (const char *name)
virtual ~VKTexture () override
void generate_mipmap () override
void copy_to (Texture *texture, IndexRange mip_levels) override
void copy_to (VKTexture &dst_texture, IndexRange mip_levels, VkImageAspectFlags vk_image_aspect)
void clear (const double4 data) override
void clear_depth_stencil (const GPUFrameBufferBits buffer, float clear_depth, uint clear_stencil, std::optional< int > layer)
void swizzle_set (const char swizzle_mask[4]) override
void read (int mip, eGPUDataFormat format, void *data) 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, VKPixelBuffer *pixel_buffer, const uint unpack_row_length=0)
void update_sub (int mip, int offset[3], int extent[3], eGPUDataFormat format, const void *data, const uint unpack_row_length) override
void update_sub (int offset[3], int extent[3], eGPUDataFormat format, GPUPixelBuffer *pixbuf) override
VKMemoryExport export_memory (VkExternalMemoryHandleTypeFlagBits handle_type)
VkImage vk_image_handle () const
ResourceHandle resource_handle () const
TextureFormat device_format_get () const
VkImageUsageFlags vk_image_usage_get () const
const VKImageView & image_view_get (const VKImageViewInfo &info)
const VKImageView & image_view_get (VKImageViewArrayed arrayed, VKImageViewFlags flags)
Public Member Functions inherited from blender::gpu::Texture
int width_get () const
int height_get () const
int depth_get () const
eGPUTextureUsage usage_get () const
bool is_texture_view () const
void mip_size_get (int mip, int r_size[3]) const
int3 mip_size_get (int mip) 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
IndexRange mip_map_range () const
IndexRange layer_range () const
TextureFormat format_get () const
GPUTextureFormatFlag format_flag_get () const
GPUTextureType 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, TextureFormat format)
bool init_2D (int w, int h, int layers, int mip_len, TextureFormat format)
bool init_3D (int w, int h, int d, int mip_len, TextureFormat format)
bool init_cubemap (int w, int layers, int mip_len, TextureFormat format)
bool init_buffer (VertBuf *vbo, TextureFormat format)
bool init_view (Texture *src, TextureFormat format, GPUTextureType 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)
size_t read_size_get (int mip, eGPUDataFormat format) const

Protected Member Functions

bool init_internal () override
bool init_internal (VertBuf *vbo) override
bool init_internal (gpu::Texture *src, bool use_stencil) override
void init_swapchain (VkImage vk_image, ResourceHandle resource_handle, TextureFormat gpu_format)

Friends

class VKDescriptorSetTracker
class VKDescriptorSetUpdator
class VKContext
class VKTexturePool

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_
TextureFormat format_
GPUTextureFormatFlag format_flag_
GPUTextureType type_
eGPUTextureUsage gpu_image_usage_flags_
int mipmaps_ = -1
int mip_min_ = 0
int mip_max_ = 0
Texture * source_texture_ = nullptr
int view_layer_start_ = 0
std::string name_
Map< FrameBuffer *, GPUAttachmentType > fb_attachments_

Detailed Description

Definition at line 34 of file vk_texture.hh.

Constructor & Destructor Documentation

◆ VKTexture()

◆ ~VKTexture()

Member Function Documentation

◆ clear()

◆ clear_depth_stencil()

◆ copy_to() [1/2]

◆ copy_to() [2/2]

◆ device_format_get()

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

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

Definition at line 144 of file vk_texture.hh.

Referenced by blender::gpu::blit_aspect(), clear_depth_stencil(), blender::gpu::VKTexturePool::release_texture(), and blender::gpu::VKFrameBuffer::rendering_ensure_dynamic_rendering().

◆ export_memory()

VKMemoryExport blender::gpu::VKTexture::export_memory ( VkExternalMemoryHandleTypeFlagBits handle_type)

◆ generate_mipmap()

◆ 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 802 of file vk_texture.cc.

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

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

◆ image_view_get() [2/2]

◆ init_internal() [1/3]

◆ init_internal() [2/3]

bool blender::gpu::VKTexture::init_internal ( gpu::Texture * src,
bool use_stencil )
overrideprotectedvirtual

Implements blender::gpu::Texture.

Definition at line 655 of file vk_texture.cc.

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

◆ init_internal() [3/3]

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

◆ init_swapchain()

◆ read()

◆ read_sub()

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

◆ resource_handle()

ResourceHandle blender::gpu::VKTexture::resource_handle ( ) const
inline

◆ swizzle_set()

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

Implements blender::gpu::Texture.

Definition at line 201 of file vk_texture.cc.

◆ update_sub() [1/3]

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

Implements blender::gpu::Texture.

Definition at line 536 of file vk_texture.cc.

References blender::data, and update_sub().

◆ update_sub() [2/3]

void blender::gpu::VKTexture::update_sub ( int mip,
int offset[3],
int extent[3],
eGPUDataFormat format,
const void * data,
VKPixelBuffer * pixel_buffer,
const uint unpack_row_length = 0 )

Definition at line 365 of file vk_texture.cc.

References blender::BLI_assert(), BLI_assert_msg, blender::gpu::VKPixelBuffer::buffer_get(), blender::gpu::convert_host_to_device(), blender::gpu::VKBuffer::create(), blender::data, lexit::Vector< T >::data(), blender::gpu::Texture::depth_get(), blender::gpu::VKBackend::device, blender::divide_ceil_u(), blender::gpu::render_graph::VKCopyBufferToImageData::dst_image, ELEM, blender::gpu::VKBuffer::flush_mapped_memory(), blender::gpu::Texture::format_, blender::gpu::Texture::format_flag_, blender::gpu::VKDevice::functions, blender::gpu::VKBackend::get(), blender::gpu::VKContext::get(), blender::gpu::GPU_FORMAT_COMPRESSED, blender::gpu::GPU_TEXTURE_1D, blender::gpu::GPU_TEXTURE_2D, blender::gpu::GPU_TEXTURE_CUBE, blender::gpu::Texture::height_get(), blender::gpu::Texture::is_texture_view(), blender::gpu::VKBuffer::mapped_memory_get(), blender::max_ii(), blender::gpu::Texture::mip_min_, blender::gpu::needs_conversion(), blender::gpu::render_graph::VKCopyBufferToImageCreateInfo::node_data, blender::gpu::render_graph::VKCopyBufferToImageData::region, lexit::Vector< T >::resize(), blender::gpu::VKBuffer::resource(), blender::gpu::VKDevice::resources, 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::render_graph::VKResourceStateTracker::update_image_layout(), blender::gpu::Texture::view_layer_start_, blender::gpu::VKDevice::vk_handle(), blender::gpu::render_graph::VKCopyBufferToImageCreateInfo::vk_image_aspects, vk_image_handle(), VKContext, blender::gpu::Texture::width_get(), and y.

Referenced by update_sub(), and update_sub().

◆ update_sub() [3/3]

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

Implements blender::gpu::Texture.

Definition at line 546 of file vk_texture.cc.

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

◆ vk_image_handle()

◆ vk_image_usage_get()

VkImageUsageFlags blender::gpu::VKTexture::vk_image_usage_get ( ) const
inline

Vulkan usage flags the underlying image was created with.

Definition at line 150 of file vk_texture.hh.

References blender::gpu::Texture::is_texture_view(), blender::gpu::Texture::source_texture_, vk_image_usage_get(), and VKTexture().

Referenced by vk_image_usage_get().

◆ VKContext

friend class VKContext
friend

Definition at line 37 of file vk_texture.hh.

References VKContext.

Referenced by clear(), clear_depth_stencil(), copy_to(), generate_mipmap(), read_sub(), update_sub(), and VKContext.

◆ VKDescriptorSetTracker

friend class VKDescriptorSetTracker
friend

Definition at line 35 of file vk_texture.hh.

References VKDescriptorSetTracker.

Referenced by VKDescriptorSetTracker.

◆ VKDescriptorSetUpdator

friend class VKDescriptorSetUpdator
friend

Definition at line 36 of file vk_texture.hh.

References VKDescriptorSetUpdator.

Referenced by VKDescriptorSetUpdator.

◆ VKTexturePool

friend class VKTexturePool
friend

Definition at line 38 of file vk_texture.hh.

References blender::gpu::Invalid, and VKTexturePool.

Referenced by VKTexturePool.


The documentation for this class was generated from the following files: