Blender V5.3
blender::draw::overlay::TextureFromPool Class Reference

#include <DRW_gpu_wrapper.hh>

Inherits blender::draw::Texture, and blender::blender::NonMovable.

Public Member Functions

 TextureFromPool (const char *name="draw::TextureFromPool")
 ~TextureFromPool ()
bool acquire_1d (int extent, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_1d_array (int extent, int layers, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_2d (int2 extent, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_2d_array (int2 extent, int layers, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_3d (int3 extent, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_cube (int extent, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
bool acquire_cube_array (int extent, int layers, gpu::TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, int mip_len=1)
void release ()
void retain ()
TextureFromPool * ptr ()
bool ensure_1d (int, int, blender::gpu::TextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_1d_array (int, int, int, gpu::TextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_2d (int, int, int, gpu::TextureFormat, eGPUTextureUsage, float *)=delete
bool ensure_2d_array (int, int, int, int, gpu::TextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_3d (int, int, int, int, gpu::TextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_cube (int, int, gpu::TextureFormat, eGPUTextureUsage, const float *)=delete
void filter_mode (bool)=delete
void free ()=delete
Public Member Functions inherited from blender::draw::Texture
 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 (TextureFromPool &a, TextureFromPool &b)
Static Public Member Functions inherited from blender::draw::Texture
static void swap (Texture &a, Texture &b)

Additional Inherited Members

Protected Member Functions inherited from blender::draw::Texture
void free_texture_views ()
Protected Attributes inherited from blender::draw::Texture
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 1069 of file DRW_gpu_wrapper.hh.

Constructor & Destructor Documentation

◆ TextureFromPool()

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

Definition at line 1074 of file DRW_gpu_wrapper.hh.

◆ ~TextureFromPool()

Member Function Documentation

◆ acquire_1d()

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1086 of file DRW_gpu_wrapper.hh.

◆ acquire_1d_array()

bool blender::draw::TextureFromPool::acquire_1d_array ( int extent,
int layers,
gpu::TextureFormat format,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
int mip_len = 1 )
inline

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1098 of file DRW_gpu_wrapper.hh.

◆ acquire_2d()

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1111 of file DRW_gpu_wrapper.hh.

◆ acquire_2d_array()

bool blender::draw::TextureFromPool::acquire_2d_array ( int2 extent,
int layers,
gpu::TextureFormat format,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
int mip_len = 1 )
inline

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1123 of file DRW_gpu_wrapper.hh.

◆ acquire_3d()

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1136 of file DRW_gpu_wrapper.hh.

◆ acquire_cube()

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1148 of file DRW_gpu_wrapper.hh.

◆ acquire_cube_array()

bool blender::draw::TextureFromPool::acquire_cube_array ( int extent,
int layers,
gpu::TextureFormat format,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL,
int mip_len = 1 )
inline

Acquire a texture with the correct properties from the pool. Always use ::release() or ::retain() after rendering with this texture.

Definition at line 1160 of file DRW_gpu_wrapper.hh.

◆ ensure_1d()

Remove methods that are forbidden with this type of textures.

◆ ensure_1d_array()

◆ ensure_2d()

◆ ensure_2d_array()

bool blender::draw::TextureFromPool::ensure_2d_array ( int ,
int ,
int ,
int ,
gpu::TextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

◆ ensure_3d()

bool blender::draw::TextureFromPool::ensure_3d ( int ,
int ,
int ,
int ,
gpu::TextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

◆ ensure_cube()

◆ filter_mode()

◆ free()

◆ ptr()

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

Definition at line 1195 of file DRW_gpu_wrapper.hh.

◆ release()

Definition at line 1170 of file DRW_gpu_wrapper.hh.

◆ retain()

Definition at line 1182 of file DRW_gpu_wrapper.hh.

◆ swap()

Definition at line 1188 of file DRW_gpu_wrapper.hh.


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