Blender V5.3
blender::gpu::Texture Class Referenceabstract

#include <gpu_texture_private.hh>

Inherited by blender::gpu::GLTexture, blender::gpu::MTLTexture, and blender::gpu::VKTexture.

Public Member Functions

virtual void generate_mipmap ()=0
virtual void copy_to (Texture *tex, IndexRange mip_levels)=0
virtual void clear (const double4 data)=0
virtual void swizzle_set (const char swizzle_mask[4])=0
virtual void read (int mip, eGPUDataFormat format, void *dst)=0
virtual void update_sub (int mip, int offset[3], int extent[3], eGPUDataFormat format, const void *data, uint unpack_row_length=0)=0
virtual void update_sub (int offset[3], int extent[3], eGPUDataFormat format, GPUPixelBuffer *pixbuf)=0
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
Creation & Deletion
 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)
Operation
void attach_to (FrameBuffer *fb, GPUAttachmentType type)
void detach_from (FrameBuffer *fb)
void update (eGPUDataFormat format, const void *data)
C-API
size_t read_size_get (int mip, eGPUDataFormat format) const

Public Attributes

GPUSamplerState sampler_state = GPUSamplerState::default_sampler()
int refcount = 1
int src_w = 0
int src_h = 0
void ** py_ref = nullptr

Protected Member Functions

virtual bool init_internal ()=0
virtual bool init_internal (VertBuf *vbo)=0
virtual bool init_internal (gpu::Texture *src, bool use_stencil)=0

Protected Attributes

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

Implementation of Textures. Base class which is then specialized for each implementation (GL, VK, ...).

Definition at line 105 of file gpu_texture_private.hh.

Constructor & Destructor Documentation

◆ Texture()

◆ ~Texture()

blender::gpu::Texture::~Texture ( )
virtual

Member Function Documentation

◆ attach_to()

void blender::gpu::Texture::attach_to ( FrameBuffer * fb,
GPUAttachmentType type )

Definition at line 191 of file gpu_texture.cc.

References blender::fb(), and fb_attachments_.

Referenced by read().

◆ attachment_type()

◆ clear()

◆ copy_to()

virtual void blender::gpu::Texture::copy_to ( Texture * tex,
IndexRange mip_levels )
pure virtual

◆ depth_get()

int blender::gpu::Texture::depth_get ( ) const
inline

◆ detach_from()

void blender::gpu::Texture::detach_from ( FrameBuffer * fb)

◆ dimensions_count()

◆ format_flag_get()

GPUTextureFormatFlag blender::gpu::Texture::format_flag_get ( ) const
inline

Definition at line 307 of file gpu_texture_private.hh.

References format_flag_.

Referenced by blender::gpu::GLFrameBuffer::clear_attachment().

◆ format_get()

◆ generate_mipmap()

virtual void blender::gpu::Texture::generate_mipmap ( )
pure virtual

◆ height_get()

◆ init_1D()

◆ init_2D()

◆ init_3D()

◆ init_buffer()

bool blender::gpu::Texture::init_buffer ( VertBuf * vbo,
TextureFormat format )

◆ init_cubemap()

◆ init_internal() [1/3]

virtual bool blender::gpu::Texture::init_internal ( )
protectedpure virtual

◆ init_internal() [2/3]

virtual bool blender::gpu::Texture::init_internal ( gpu::Texture * src,
bool use_stencil )
protectedpure virtual

◆ init_internal() [3/3]

virtual bool blender::gpu::Texture::init_internal ( VertBuf * vbo)
protectedpure virtual

◆ init_view()

◆ is_texture_view()

◆ layer_count()

◆ layer_range()

◆ mip_count()

◆ mip_depth_get()

int blender::gpu::Texture::mip_depth_get ( int mip) const
inline

◆ mip_height_get()

int blender::gpu::Texture::mip_height_get ( int mip) const
inline

◆ mip_map_range()

◆ mip_size_get() [1/2]

int3 blender::gpu::Texture::mip_size_get ( int mip) const
inline

Definition at line 237 of file gpu_texture_private.hh.

References mip_size_get().

◆ mip_size_get() [2/2]

◆ mip_width_get()

int blender::gpu::Texture::mip_width_get ( int mip) const
inline

Definition at line 243 of file gpu_texture_private.hh.

References blender::max_ii(), and w_.

◆ read()

virtual void blender::gpu::Texture::read ( int mip,
eGPUDataFormat format,
void * dst )
pure virtual

◆ read_size_get()

◆ swizzle_set()

virtual void blender::gpu::Texture::swizzle_set ( const char swizzle_mask[4])
pure virtual

◆ type_get()

◆ update()

void blender::gpu::Texture::update ( eGPUDataFormat format,
const void * data )

Definition at line 211 of file gpu_texture.cc.

References blender::data, mip_size_get(), and update_sub().

Referenced by blender::GPU_texture_update(), and read().

◆ update_sub() [1/2]

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

◆ update_sub() [2/2]

virtual void blender::gpu::Texture::update_sub ( int offset[3],
int extent[3],
eGPUDataFormat format,
GPUPixelBuffer * pixbuf )
pure virtual

◆ usage_get()

◆ usage_set()

◆ width_get()

Member Data Documentation

◆ d_

◆ fb_attachments_

Map<FrameBuffer *, GPUAttachmentType> blender::gpu::Texture::fb_attachments_
protected

Framebuffer references to update on deletion.

Definition at line 149 of file gpu_texture_private.hh.

Referenced by attach_to(), blender::gpu::GLTexture::check_feedback_loop(), detach_from(), and ~Texture().

◆ format_

◆ format_flag_

◆ gpu_image_usage_flags_

◆ h_

◆ mip_max_

◆ mip_min_

◆ mipmaps_

◆ name_

◆ py_ref

void** blender::gpu::Texture::py_ref = nullptr

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

Definition at line 118 of file gpu_texture_private.hh.

Referenced by ~Texture().

◆ refcount

int blender::gpu::Texture::refcount = 1

Reference counter.

Definition at line 110 of file gpu_texture_private.hh.

◆ sampler_state

◆ source_texture_

◆ src_h

int blender::gpu::Texture::src_h = 0

Definition at line 112 of file gpu_texture_private.hh.

◆ src_w

int blender::gpu::Texture::src_w = 0

Width & Height (of source data), optional.

Definition at line 112 of file gpu_texture_private.hh.

◆ type_

◆ view_layer_start_

◆ w_


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