Blender V4.5
Public Member Functions | Static Public Member Functions | List of all members
blender::draw::overlay::TextureFromPool Class Reference

#include <DRW_gpu_wrapper.hh>

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

Public Member Functions

 TextureFromPool (const char *name="gpu::Texture")
void acquire (int2int2 extent, eGPUTextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL)
void release ()
TextureFromPool * ptr ()
bool ensure_1d (int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_1d_array (int, int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_2d (int, int, int, eGPUTextureFormat, eGPUTextureUsage, float *)=delete
bool ensure_2d_array (int, int, int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_3d (int, int, int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_cube (int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
bool ensure_cube_array (int, int, int, eGPUTextureFormat, eGPUTextureUsage, const float *)=delete
void filter_mode (bool)=delete
void free ()=delete
GPUTexture * mip_view (int)=delete
GPUTexture * layer_view (int)=delete
GPUTexture * stencil_view ()=delete
Public Member Functions inherited from blender::draw::Texture
 Texture (const char *name="gpu::Texture")
 Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int extent, const float *data=nullptr, bool cubemap=false, int mip_len=1)
 Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int extent, int layers, const float *data=nullptr, bool cubemap=false, int mip_len=1)
 Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int2int2 extent, const float *data=nullptr, int mip_len=1)
 Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int2int2 extent, int layers, const float *data=nullptr, int mip_len=1)
 Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int3int3 extent, const float *data=nullptr, int mip_len=1)
 Texture (Texture &&other)=default
 ~Texture ()
GPUTexture * gpu_texture ()
 operator GPUTexture * () const
GPUTexture ** operator& ()
Texture * ptr ()
Texture & operator= (Texture &&a)
bool ensure_1d (eGPUTextureFormat format, int extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_1d_array (eGPUTextureFormat format, int extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_2d (eGPUTextureFormat format, int2int2 extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_2d_array (eGPUTextureFormat format, int2int2 extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_3d (eGPUTextureFormat format, int3int3 extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool ensure_cube (eGPUTextureFormat format, int extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, float *data=nullptr, int mip_len=1)
bool ensure_cube_array (eGPUTextureFormat 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)
GPUTexture * mip_view (int miplvl)
int mip_count () const
bool ensure_layer_views (bool cube_as_array=false)
GPUTexture * layer_view (int layer)
GPUTexture * stencil_view (bool cube_as_array=false)
GPUTexture * 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
int3int3 size (int miplvl=0) const
void clear (float4 values)
void clear (uint4uint4 values)
void clear (int4int4 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, Texture &b)
static void swap (Texture &a, TextureFromPool &b)
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
GPUTexture * tx_ = nullptr
GPUTexture * stencil_view_ = nullptr
Vector< GPUTexture *, 0 > mip_views_
Vector< GPUTexture *, 0 > layer_views_
GPUTexture * layer_range_view_ = nullptr
const char * name_

Detailed Description

Definition at line 1066 of file DRW_gpu_wrapper.hh.

Constructor & Destructor Documentation

◆ TextureFromPool()

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

Definition at line 1068 of file DRW_gpu_wrapper.hh.

Member Function Documentation

◆ acquire()

void blender::draw::TextureFromPool::acquire ( int2int2 extent,
eGPUTextureFormat format,
eGPUTextureUsage usage = GPU_TEXTURE_USAGE_GENERAL )
inline

Definition at line 1071 of file DRW_gpu_wrapper.hh.

◆ ensure_1d()

bool blender::draw::TextureFromPool::ensure_1d ( int ,
int ,
eGPUTextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

Remove methods that are forbidden with this type of textures.

◆ ensure_1d_array()

bool blender::draw::TextureFromPool::ensure_1d_array ( int ,
int ,
int ,
eGPUTextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

◆ ensure_2d()

bool blender::draw::TextureFromPool::ensure_2d ( int ,
int ,
int ,
eGPUTextureFormat ,
eGPUTextureUsage ,
float *  )
delete

◆ ensure_2d_array()

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

◆ ensure_3d()

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

◆ ensure_cube()

bool blender::draw::TextureFromPool::ensure_cube ( int ,
int ,
eGPUTextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

◆ ensure_cube_array()

bool blender::draw::TextureFromPool::ensure_cube_array ( int ,
int ,
int ,
eGPUTextureFormat ,
eGPUTextureUsage ,
const float *  )
delete

◆ filter_mode()

void blender::draw::TextureFromPool::filter_mode ( bool )
delete

◆ free()

void blender::draw::TextureFromPool::free ( )
delete

◆ layer_view()

GPUTexture * blender::draw::TextureFromPool::layer_view ( int )
delete

◆ mip_view()

GPUTexture * blender::draw::TextureFromPool::mip_view ( int )
delete

◆ ptr()

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

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

Definition at line 1114 of file DRW_gpu_wrapper.hh.

◆ release()

void blender::draw::TextureFromPool::release ( )
inline

Definition at line 1084 of file DRW_gpu_wrapper.hh.

◆ stencil_view()

GPUTexture * blender::draw::TextureFromPool::stencil_view ( )
delete

◆ swap() [1/3]

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

Definition at line 1104 of file DRW_gpu_wrapper.hh.

◆ swap() [2/3]

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

Swap the content of the two textures. Also change ownership accordingly if needed.

Definition at line 1098 of file DRW_gpu_wrapper.hh.

◆ swap() [3/3]

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

Definition at line 1108 of file DRW_gpu_wrapper.hh.

The documentation for this class was generated from the following file:
Generated on for Blender by  doxygen 1.15.0