blender::draw::overlay::Texture Class Reference

#include <DRW_gpu_wrapper.hh>

Inherits 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, 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, int2 extent, const float *data=nullptr, int mip_len=1)
	Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int2 extent, int layers, const float *data=nullptr, int mip_len=1)
	Texture (const char *name, eGPUTextureFormat format, eGPUTextureUsage usage, int3 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, int2 extent, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool	ensure_2d_array (eGPUTextureFormat format, int2 extent, int layers, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const float *data=nullptr, int mip_len=1)
bool	ensure_3d (eGPUTextureFormat format, int3 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
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 Attributes
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 526 of file DRW_gpu_wrapper.hh.

Constructor & Destructor Documentation

Texture() [1/7]

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

inline

Definition at line 536 of file DRW_gpu_wrapper.hh.

Texture() [2/7]

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

inline

Definition at line 538 of file DRW_gpu_wrapper.hh.

Texture() [3/7]

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

inline

Definition at line 550 of file DRW_gpu_wrapper.hh.

Texture() [4/7]

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

inline

Definition at line 563 of file DRW_gpu_wrapper.hh.

Texture() [5/7]

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

inline

Definition at line 574 of file DRW_gpu_wrapper.hh.

Texture() [6/7]

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

inline

Definition at line 586 of file DRW_gpu_wrapper.hh.

Texture() [7/7]

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

default

~Texture()

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

inline

Definition at line 598 of file DRW_gpu_wrapper.hh.

Member Function Documentation

clear() [1/3]

void blender::draw::Texture::clear ( float4 values )

inline

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

Definition at line 906 of file DRW_gpu_wrapper.hh.

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 922 of file DRW_gpu_wrapper.hh.

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 914 of file DRW_gpu_wrapper.hh.

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 931 of file DRW_gpu_wrapper.hh.

depth()

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

inline

Definition at line 861 of file DRW_gpu_wrapper.hh.

ensure_1d()

bool blender::draw::Texture::ensure_1d ( eGPUTextureFormat 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 653 of file DRW_gpu_wrapper.hh.

ensure_1d_array()

bool blender::draw::Texture::ensure_1d_array ( eGPUTextureFormat 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 666 of file DRW_gpu_wrapper.hh.

ensure_2d()

bool blender::draw::Texture::ensure_2d ( eGPUTextureFormat format, int2 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 681 of file DRW_gpu_wrapper.hh.

ensure_2d_array()

bool blender::draw::Texture::ensure_2d_array ( eGPUTextureFormat 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 694 of file DRW_gpu_wrapper.hh.

ensure_3d()

bool blender::draw::Texture::ensure_3d ( eGPUTextureFormat 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 709 of file DRW_gpu_wrapper.hh.

ensure_cube()

bool blender::draw::Texture::ensure_cube ( eGPUTextureFormat 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 722 of file DRW_gpu_wrapper.hh.

ensure_cube_array()

bool blender::draw::Texture::ensure_cube_array ( eGPUTextureFormat 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 735 of file DRW_gpu_wrapper.hh.

ensure_layer_views()

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

inline

Ensure the availability of layer views. Layer views covers all layers of array textures. Returns true if the views were (re)created.

Definition at line 784 of file DRW_gpu_wrapper.hh.

ensure_mip_views()

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

inline

Ensure the availability of mipmap views. MIP view covers all layers of array textures.

Definition at line 749 of file DRW_gpu_wrapper.hh.

filter_mode()

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

inline

Definition at line 955 of file DRW_gpu_wrapper.hh.

free()

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

inline

Free the internal texture but not the draw::Texture itself.

Definition at line 963 of file DRW_gpu_wrapper.hh.

gpu_texture()

GPUTexture * blender::draw::Texture::gpu_texture ( )

inline

Definition at line 603 of file DRW_gpu_wrapper.hh.

height()

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

inline

Definition at line 856 of file DRW_gpu_wrapper.hh.

is_array()

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

inline

Definition at line 891 of file DRW_gpu_wrapper.hh.

is_cube()

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

inline

Definition at line 886 of file DRW_gpu_wrapper.hh.

is_depth()

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

inline

Definition at line 871 of file DRW_gpu_wrapper.hh.

is_integer()

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

inline

Definition at line 881 of file DRW_gpu_wrapper.hh.

is_stencil()

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

inline

Definition at line 876 of file DRW_gpu_wrapper.hh.

is_valid()

bool blender::draw::Texture::is_valid ( ) const

inline

Returns true if the texture has been allocated or acquired from the pool.

Definition at line 846 of file DRW_gpu_wrapper.hh.

layer_range_view()

GPUTexture * 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 called to create one range. View is recreated if:

• The source texture is recreated.
• The layer_len is different from the last call the 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 825 of file DRW_gpu_wrapper.hh.

layer_view()

GPUTexture * blender::draw::Texture::layer_view ( int layer )

inline

Definition at line 801 of file DRW_gpu_wrapper.hh.

mip_count()

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

inline

Definition at line 774 of file DRW_gpu_wrapper.hh.

mip_view()

GPUTexture * blender::draw::Texture::mip_view ( int miplvl )

inline

Definition at line 766 of file DRW_gpu_wrapper.hh.

operator GPUTexture *()

blender::draw::Texture::operator GPUTexture * ( ) const

inline

Definition at line 609 of file DRW_gpu_wrapper.hh.

operator&()

GPUTexture ** blender::draw::Texture::operator& ( )

inline

Definition at line 616 of file DRW_gpu_wrapper.hh.

operator=()

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

inline

Definition at line 627 of file DRW_gpu_wrapper.hh.

pixel_count()

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

inline

Definition at line 866 of file DRW_gpu_wrapper.hh.

ptr()

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

inline

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

Definition at line 622 of file DRW_gpu_wrapper.hh.

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_freeN().

Definition at line 950 of file DRW_gpu_wrapper.hh.

size()

int3 blender::draw::Texture::size ( int miplvl = 0 ) const

inline

Definition at line 896 of file DRW_gpu_wrapper.hh.

stencil_view()

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

inline

Definition at line 806 of file DRW_gpu_wrapper.hh.

swap()

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

inlinestatic

Swap the content of the two textures.

Definition at line 981 of file DRW_gpu_wrapper.hh.

width()

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

inline

Definition at line 851 of file DRW_gpu_wrapper.hh.

Member Data Documentation

layer_range_view_

GPUTexture* blender::draw::Texture::layer_range_view_ = nullptr

protected

Definition at line 532 of file DRW_gpu_wrapper.hh.

layer_views_

Vector<GPUTexture *, 0> blender::draw::Texture::layer_views_

protected

Definition at line 531 of file DRW_gpu_wrapper.hh.

mip_views_

Vector<GPUTexture *, 0> blender::draw::Texture::mip_views_

protected

Definition at line 530 of file DRW_gpu_wrapper.hh.

name_

const char* blender::draw::Texture::name_

protected

Definition at line 533 of file DRW_gpu_wrapper.hh.

stencil_view_

GPUTexture* blender::draw::Texture::stencil_view_ = nullptr

protected

Definition at line 529 of file DRW_gpu_wrapper.hh.

tx_

GPUTexture* blender::draw::Texture::tx_ = nullptr

protected

Definition at line 528 of file DRW_gpu_wrapper.hh.

---

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

• DRW_gpu_wrapper.hh