Blender V5.3
blender::draw::Texture Class Reference

#include <DRW_gpu_wrapper.hh>

Inherits blender::blender::NonCopyable.

Inherited by blender::draw::TextureFromPool, blender::draw::TextureRef, and blender::eevee::UtilityTexture.

Public Member Functions

 Texture (const char *name="gpu::Texture")
 Texture (const char *name, gpu::TextureFormat format, eGPUTextureUsage usage, int extent, const float *data=nullptr, bool cubemap=false, int mip_len=1)
 Texture (const char *name, gpu::TextureFormat format, eGPUTextureUsage usage, int extent, int layers, const float *data=nullptr, bool cubemap=false, int mip_len=1)
 Texture (const char *name, gpu::TextureFormat format, eGPUTextureUsage usage, int2 extent, const float *data=nullptr, int mip_len=1)
 Texture (const char *name, gpu::TextureFormat format, eGPUTextureUsage usage, int2 extent, int layers, const float *data=nullptr, int mip_len=1)
 Texture (const char *name, gpu::TextureFormat format, eGPUTextureUsage usage, int3 extent, const float *data=nullptr, int mip_len=1)
 Texture (Texture &&other)=default
 ~Texture ()
gpu::Texture * gpu_texture ()
 operator gpu::Texture * () const
gpu::Texture ** operator& ()
Texture * ptr ()
Texture & operator= (Texture &&a)
bool ensure_1d (gpu::TextureFormat format, int extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_1d_array (gpu::TextureFormat format, int extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_2d (gpu::TextureFormat format, int2 extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_2d_array (gpu::TextureFormat format, int2 extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_3d (gpu::TextureFormat format, int3 extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_cube (gpu::TextureFormat format, int extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, float *data=nullptr, int mip_len=1)
bool ensure_cube_array (gpu::TextureFormat format, int extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_mip_views (bool cube_as_array=false)
gpu::Texture * mip_view (int miplvl)
int mip_count () const
bool ensure_layer_views (bool cube_as_array=false)
gpu::Texture * layer_view (int layer)
gpu::Texture * stencil_view (bool cube_as_array=false)
gpu::Texture * layer_range_view (int layer_start, int layer_len, bool cube_as_array=false)
bool is_valid () const
int width () const
int height () const
int depth () const
int pixel_count () const
bool is_depth () const
bool is_stencil () const
bool is_integer () const
bool is_cube () const
bool is_array () const
int3 size (int miplvl=0) const
void clear (float4 values)
void clear (uint4 values)
void clear (int4 values)
void debug_clear ()
template<typename T>
T * read (eGPUDataFormat format, int miplvl=0)
void filter_mode (bool do_filter)
void free ()

Static Public Member Functions

static void swap (Texture &a, Texture &b)

Protected Member Functions

void free_texture_views ()

Protected Attributes

gpu::Texture * tx_ = nullptr
gpu::Texture * stencil_view_ = nullptr
Vector< gpu::Texture *, 0 > mip_views_
Vector< gpu::Texture *, 0 > layer_views_
gpu::Texture * layer_range_view_ = nullptr
const char * name_

Detailed Description

Definition at line 528 of file DRW_gpu_wrapper.hh.

Constructor & Destructor Documentation

◆ Texture() [1/7]

blender::draw::Texture::Texture ( const char * name = "gpu::Texture")
inline

◆ Texture() [2/7]

blender::draw::Texture::Texture ( const char * name,
gpu::TextureFormat format,
eGPUTextureUsage usage,
int extent,
const float * data = nullptr,
bool cubemap = false,
int mip_len = 1 )
inline

Definition at line 540 of file DRW_gpu_wrapper.hh.

References blender::data, name_, and tx_.

◆ Texture() [3/7]

blender::draw::Texture::Texture ( const char * name,
gpu::TextureFormat format,
eGPUTextureUsage usage,
int extent,
int layers,
const float * data = nullptr,
bool cubemap = false,
int mip_len = 1 )
inline

Definition at line 552 of file DRW_gpu_wrapper.hh.

References blender::data, name_, and tx_.

◆ Texture() [4/7]

blender::draw::Texture::Texture ( const char * name,
gpu::TextureFormat format,
eGPUTextureUsage usage,
int2 extent,
const float * data = nullptr,
int mip_len = 1 )
inline

Definition at line 565 of file DRW_gpu_wrapper.hh.

References blender::data, name_, tx_, and UNPACK2.

◆ Texture() [5/7]

blender::draw::Texture::Texture ( const char * name,
gpu::TextureFormat format,
eGPUTextureUsage usage,
int2 extent,
int layers,
const float * data = nullptr,
int mip_len = 1 )
inline

Definition at line 576 of file DRW_gpu_wrapper.hh.

References blender::data, name_, tx_, and UNPACK2.

◆ Texture() [6/7]

blender::draw::Texture::Texture ( const char * name,
gpu::TextureFormat format,
eGPUTextureUsage usage,
int3 extent,
const float * data = nullptr,
int mip_len = 1 )
inline

Definition at line 588 of file DRW_gpu_wrapper.hh.

References blender::data, name_, tx_, and UNPACK3.

◆ Texture() [7/7]

blender::draw::Texture::Texture ( Texture && other)
default

References Texture().

◆ ~Texture()

blender::draw::Texture::~Texture ( )
inline

Definition at line 600 of file DRW_gpu_wrapper.hh.

References free().

Member Function Documentation

◆ clear() [1/3]

◆ clear() [2/3]

void blender::draw::Texture::clear ( int4 values)
inline

Clear the entirety of the texture using one pixel worth of data.

Definition at line 924 of file DRW_gpu_wrapper.hh.

References blender::GPU_DATA_INT, blender::GPU_texture_clear(), and tx_.

◆ clear() [3/3]

void blender::draw::Texture::clear ( uint4 values)
inline

Clear the entirety of the texture using one pixel worth of data.

Definition at line 916 of file DRW_gpu_wrapper.hh.

References blender::GPU_DATA_UINT, blender::GPU_texture_clear(), and tx_.

◆ debug_clear()

void blender::draw::Texture::debug_clear ( )
inline

Clear the texture to NaN for floats, or a to debug value for integers. (For debugging uninitialized data issues)

Definition at line 933 of file DRW_gpu_wrapper.hh.

References clear(), blender::GPU_texture_dimensions(), blender::GPU_texture_has_float_format(), blender::GPU_texture_has_integer_format(), blender::GPU_texture_has_normalized_format(), blender::GPU_texture_has_signed_format(), and NAN_FLT.

Referenced by blender::draw::TextureFromPool::free().

◆ depth()

int blender::draw::Texture::depth ( ) const
inline

Definition at line 863 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_depth(), and tx_.

◆ ensure_1d()

bool blender::draw::Texture::ensure_1d ( gpu::TextureFormat format,
int extent,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
const float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 655 of file DRW_gpu_wrapper.hh.

References blender::data, and blender::GPU_TEXTURE_USAGE_GENERAL.

◆ ensure_1d_array()

bool blender::draw::Texture::ensure_1d_array ( gpu::TextureFormat format,
int extent,
int layers,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
const float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 668 of file DRW_gpu_wrapper.hh.

References blender::BLI_assert(), blender::data, and blender::GPU_TEXTURE_USAGE_GENERAL.

Referenced by blender::workbench::SceneResources::init().

◆ ensure_2d()

◆ ensure_2d_array()

bool blender::draw::Texture::ensure_2d_array ( gpu::TextureFormat format,
int2 extent,
int layers,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
const float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 696 of file DRW_gpu_wrapper.hh.

References blender::BLI_assert(), blender::data, blender::GPU_TEXTURE_USAGE_GENERAL, and UNPACK2.

Referenced by blender::eevee::PlanarProbeModule::init(), and blender::workbench::SceneResources::init().

◆ ensure_3d()

bool blender::draw::Texture::ensure_3d ( gpu::TextureFormat format,
int3 extent,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
const float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 711 of file DRW_gpu_wrapper.hh.

References blender::data, blender::GPU_TEXTURE_USAGE_GENERAL, and UNPACK3.

Referenced by blender::eevee::Precompute::Precompute(), blender::eevee::VolumeProbeModule::set_view(), and blender::draw::VolumeModule::VolumeModule().

◆ ensure_cube()

bool blender::draw::Texture::ensure_cube ( gpu::TextureFormat format,
int extent,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 724 of file DRW_gpu_wrapper.hh.

References blender::data, and blender::GPU_TEXTURE_USAGE_GENERAL.

◆ ensure_cube_array()

bool blender::draw::Texture::ensure_cube_array ( gpu::TextureFormat format,
int extent,
int layers,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
const float * data = nullptr,
int mip_len = 1 )
inline

Ensure the texture has the correct properties. Recreating it if needed. Return true if a texture has been created.

Definition at line 737 of file DRW_gpu_wrapper.hh.

References blender::data, and blender::GPU_TEXTURE_USAGE_GENERAL.

◆ ensure_layer_views()

bool blender::draw::Texture::ensure_layer_views ( bool cube_as_array = false)
inline

◆ ensure_mip_views()

bool blender::draw::Texture::ensure_mip_views ( bool cube_as_array = false)
inline

◆ filter_mode()

void blender::draw::Texture::filter_mode ( bool do_filter)
inline

Definition at line 962 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_filter_mode(), and tx_.

◆ free()

void blender::draw::Texture::free ( )
inline

◆ free_texture_views()

void blender::draw::Texture::free_texture_views ( )
inlineprotected

◆ gpu_texture()

◆ height()

int blender::draw::Texture::height ( ) const
inline

Definition at line 858 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_height(), and tx_.

Referenced by blender::eevee::MotionBlurModule::render().

◆ is_array()

bool blender::draw::Texture::is_array ( ) const
inline

Definition at line 893 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_is_array(), and tx_.

◆ is_cube()

bool blender::draw::Texture::is_cube ( ) const
inline

Definition at line 888 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_is_cube(), and tx_.

◆ is_depth()

bool blender::draw::Texture::is_depth ( ) const
inline

Definition at line 873 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_has_depth_format(), and tx_.

◆ is_integer()

bool blender::draw::Texture::is_integer ( ) const
inline

Definition at line 883 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_has_integer_format(), and tx_.

◆ is_stencil()

bool blender::draw::Texture::is_stencil ( ) const
inline

Definition at line 878 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_has_stencil_format(), and tx_.

◆ is_valid()

◆ layer_range_view()

gpu::Texture * blender::draw::Texture::layer_range_view ( int layer_start,
int layer_len,
bool cube_as_array = false )
inline

Layer range view cover only the given range. This can only be called to create one range. View is recreated if:

  • The source texture is recreated.
  • The layer_len is different from the last call to this function. IMPORTANT: It is not recreated if the layer_start is different from the last call. IMPORTANT: If this view is recreated any reference to it should be updated.

Definition at line 827 of file DRW_gpu_wrapper.hh.

References blender::BLI_assert(), BLI_assert_msg, blender::GPU_texture_create_view(), blender::GPU_texture_format(), GPU_TEXTURE_FREE_SAFE, blender::GPU_texture_layer_count(), is_valid(), layer_range_view_, name_, and tx_.

◆ layer_view()

◆ mip_count()

int blender::draw::Texture::mip_count ( ) const
inline

Definition at line 776 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_mip_count(), and tx_.

Referenced by blender::texture_update_mipmap_chain().

◆ mip_view()

gpu::Texture * blender::draw::Texture::mip_view ( int miplvl)
inline

◆ operator gpu::Texture *()

blender::draw::Texture::operator gpu::Texture * ( ) const
inline

Definition at line 611 of file DRW_gpu_wrapper.hh.

References blender::BLI_assert(), and tx_.

◆ operator&()

gpu::Texture ** blender::draw::Texture::operator& ( )
inline

Definition at line 618 of file DRW_gpu_wrapper.hh.

References tx_.

◆ operator=()

Texture & blender::draw::Texture::operator= ( Texture && a)
inline

Definition at line 629 of file DRW_gpu_wrapper.hh.

References free(), blender::gpu::Texture::name_, and Texture().

◆ pixel_count()

int blender::draw::Texture::pixel_count ( ) const
inline

◆ ptr()

Texture * blender::draw::Texture::ptr ( )
inline

WORKAROUND: used when needing a ref to the Texture and not the gpu::Texture.

Definition at line 624 of file DRW_gpu_wrapper.hh.

References Texture().

Referenced by blender::workbench::VolumePass::draw().

◆ read()

template<typename T>
T * blender::draw::Texture::read ( eGPUDataFormat format,
int miplvl = 0 )
inline

Returns a buffer containing the texture data for the specified miplvl. The memory block needs to be manually freed by MEM_delete().

Definition at line 957 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_read(), T, and tx_.

Referenced by blender::eevee::Precompute::Precompute(), blender::draw::test_eevee_shadow_finalize(), and blender::draw::test_eevee_shadow_tilemap_amend().

◆ size()

◆ stencil_view()

gpu::Texture * blender::draw::Texture::stencil_view ( bool cube_as_array = false)
inline

◆ swap()

void blender::draw::Texture::swap ( Texture & a,
Texture & b )
inlinestatic

Swap the content of the two textures.

Definition at line 979 of file DRW_gpu_wrapper.hh.

References b, layer_range_view_, layer_views_, mip_views_, name_, stencil_view_, Texture(), and tx_.

Referenced by blender::draw::TextureFromPool::swap().

◆ width()

int blender::draw::Texture::width ( ) const
inline

Definition at line 853 of file DRW_gpu_wrapper.hh.

References blender::GPU_texture_width(), and tx_.

Referenced by blender::eevee::MotionBlurModule::render().

Member Data Documentation

◆ layer_range_view_

gpu::Texture* blender::draw::Texture::layer_range_view_ = nullptr
protected

Definition at line 534 of file DRW_gpu_wrapper.hh.

Referenced by free_texture_views(), layer_range_view(), and swap().

◆ layer_views_

Vector<gpu::Texture *, 0> blender::draw::Texture::layer_views_
protected

Definition at line 533 of file DRW_gpu_wrapper.hh.

Referenced by ensure_layer_views(), free_texture_views(), layer_view(), and swap().

◆ mip_views_

Vector<gpu::Texture *, 0> blender::draw::Texture::mip_views_
protected

Definition at line 532 of file DRW_gpu_wrapper.hh.

Referenced by ensure_mip_views(), free_texture_views(), mip_view(), and swap().

◆ name_

◆ stencil_view_

gpu::Texture* blender::draw::Texture::stencil_view_ = nullptr
protected

Definition at line 531 of file DRW_gpu_wrapper.hh.

Referenced by free_texture_views(), stencil_view(), and swap().

◆ tx_


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