#include <DRW_gpu_wrapper.hh>

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 Member Functions
void	free_texture_views ()

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

References name_.

Referenced by operator=(), ptr(), swap(), blender::draw::TextureFromPool::swap(), blender::draw::TextureFromPool::swap(), Texture(), blender::draw::TextureFromPool::TextureFromPool(), and blender::eevee::UtilityTexture::UtilityTexture().

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

References data, name_, and tx_.

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

References data, name_, and tx_.

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

References data, name_, tx_, and UNPACK2.

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

References data, name_, tx_, and UNPACK2.

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

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

References free().

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

References GPU_DATA_FLOAT, GPU_texture_clear(), and tx_.

Referenced by debug_clear(), blender::eevee::DepthOfField::render(), blender::eevee::VolumeLayer::render(), and blender::draw::test_eevee_shadow_finalize().

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

References GPU_DATA_INT, 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 913 of file DRW_gpu_wrapper.hh.

References GPU_DATA_UINT, 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 930 of file DRW_gpu_wrapper.hh.

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

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

◆ depth()

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

inline

Definition at line 860 of file DRW_gpu_wrapper.hh.

References GPU_texture_depth(), and tx_.

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

References data, and GPU_TEXTURE_USAGE_GENERAL.

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

References BLI_assert, data, and GPU_TEXTURE_USAGE_GENERAL.

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

References data, GPU_TEXTURE_USAGE_GENERAL, and UNPACK2.

Referenced by blender::eevee::DepthOfField::render(), blender::draw::gpencil::render_init_buffers(), blender::draw::test_draw_pass_all_commands(), blender::draw::test_draw_resource_id_gen(), blender::draw::test_draw_submit_only(), blender::draw::test_draw_visibility(), blender::draw::test_eevee_shadow_finalize(), and blender::draw::test_eevee_shadow_tilemap_amend().

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

References BLI_assert, data, GPU_TEXTURE_USAGE_GENERAL, and UNPACK2.

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

References data, GPU_TEXTURE_USAGE_GENERAL, and UNPACK3.

Referenced by blender::eevee::Precompute::Precompute().

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

References data, and GPU_TEXTURE_USAGE_GENERAL.

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

References data, and GPU_TEXTURE_USAGE_GENERAL.

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

References GPU_texture_create_view(), GPU_texture_format(), GPU_TEXTURE_FREE_SAFE, GPU_texture_layer_count(), i, layer_views_, name_, tx_, and view.

Referenced by blender::eevee::Film::get_aov_texture(), and blender::eevee::Film::get_pass_texture().

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

References GPU_texture_create_view(), GPU_texture_format(), GPU_TEXTURE_FREE_SAFE, GPU_texture_mip_count(), i, mip_views_, name_, tx_, and view.

◆ filter_mode()

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

inline

Definition at line 959 of file DRW_gpu_wrapper.hh.

References GPU_texture_filter_mode(), and tx_.

◆ free()

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

inline

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

Definition at line 967 of file DRW_gpu_wrapper.hh.

References free_texture_views(), GPU_TEXTURE_FREE_SAFE, and tx_.

Referenced by operator=(), and ~Texture().

◆ free_texture_views()

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

inlineprotected

Definition at line 987 of file DRW_gpu_wrapper.hh.

References GPU_TEXTURE_FREE_SAFE, layer_range_view_, layer_views_, mip_views_, stencil_view_, and view.

Referenced by free(), and blender::draw::TextureRef::wrap().

◆ gpu_texture()

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

inline

Definition at line 602 of file DRW_gpu_wrapper.hh.

References tx_.

Referenced by blender::draw::compositor_engine::Context::get_pass().

◆ height()

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

inline

Definition at line 855 of file DRW_gpu_wrapper.hh.

References GPU_texture_height(), and tx_.

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

◆ is_array()

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

inline

Definition at line 890 of file DRW_gpu_wrapper.hh.

References GPU_texture_is_array(), and tx_.

◆ is_cube()

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

inline

Definition at line 885 of file DRW_gpu_wrapper.hh.

References GPU_texture_is_cube(), and tx_.

◆ is_depth()

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

inline

Definition at line 870 of file DRW_gpu_wrapper.hh.

References GPU_texture_has_depth_format(), and tx_.

◆ is_integer()

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

inline

Definition at line 880 of file DRW_gpu_wrapper.hh.

References GPU_texture_has_integer_format(), and tx_.

◆ is_stencil()

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

inline

Definition at line 875 of file DRW_gpu_wrapper.hh.

References GPU_texture_has_stencil_format(), and tx_.

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

References tx_.

Referenced by blender::draw::overlay::Resources::acquire(), blender::workbench::AntiAliasingPass::draw(), blender::workbench::OpaquePass::draw(), blender::workbench::TransparentDepthPass::draw(), blender::draw::overlay::MeshUVs::end_sync(), layer_range_view(), blender::eevee::RayTraceModule::render(), and blender::draw::gpencil::render_init_buffers().

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

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

◆ layer_view()

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

inline

Definition at line 800 of file DRW_gpu_wrapper.hh.

References layer_views_.

Referenced by blender::eevee::Film::get_aov_texture(), blender::eevee::Film::get_pass_texture(), blender::eevee::ShadingView::render(), and blender::eevee::PlanarProbeModule::set_view().

◆ mip_count()

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

inline

Definition at line 773 of file DRW_gpu_wrapper.hh.

References GPU_texture_mip_count(), and tx_.

◆ mip_view()

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

inline

Definition at line 765 of file DRW_gpu_wrapper.hh.

References BLI_assert_msg, and mip_views_.

◆ operator GPUTexture *()

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

inline

Definition at line 608 of file DRW_gpu_wrapper.hh.

References BLI_assert, and tx_.

◆ operator&()

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

inline

Definition at line 615 of file DRW_gpu_wrapper.hh.

References tx_.

◆ operator=()

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

inline

Definition at line 626 of file DRW_gpu_wrapper.hh.

References free(), and Texture().

◆ pixel_count()

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

inline

Definition at line 865 of file DRW_gpu_wrapper.hh.

References GPU_texture_height(), GPU_texture_width(), and tx_.

◆ ptr()

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

inline

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

Definition at line 621 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_freeN().

Definition at line 954 of file DRW_gpu_wrapper.hh.

References 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()

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

inline

Definition at line 895 of file DRW_gpu_wrapper.hh.

References GPU_texture_get_mipmap_size(), size(), and tx_.

Referenced by blender::draw::overlay::Resources::acquire(), blender::draw::overlay::Wireframe::copy_depth(), blender::draw::overlay::Outline::draw_line_only_ex(), blender::draw::overlay::MeshUVs::end_sync(), blender::draw::gpencil::render_frame(), and size().

◆ stencil_view()

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

inline

Definition at line 805 of file DRW_gpu_wrapper.hh.

References GPU_texture_create_view(), GPU_texture_format(), name_, stencil_view_, and tx_.

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

◆ swap()

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

inlinestatic

Swap the content of the two textures.

Definition at line 976 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(), and blender::draw::TextureFromPool::swap().

◆ width()

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

inline

Definition at line 850 of file DRW_gpu_wrapper.hh.

References GPU_texture_width(), and tx_.

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

Member Data Documentation

◆ layer_range_view_

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

protected

Definition at line 531 of file DRW_gpu_wrapper.hh.

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

◆ layer_views_

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

protected

Definition at line 530 of file DRW_gpu_wrapper.hh.

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

◆ mip_views_

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

protected

Definition at line 529 of file DRW_gpu_wrapper.hh.

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

◆ name_

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

protected

Definition at line 532 of file DRW_gpu_wrapper.hh.

Referenced by ensure_layer_views(), ensure_mip_views(), layer_range_view(), stencil_view(), swap(), Texture(), Texture(), Texture(), Texture(), Texture(), and Texture().

◆ stencil_view_

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

protected

Definition at line 528 of file DRW_gpu_wrapper.hh.

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

◆ tx_

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

protected

Definition at line 527 of file DRW_gpu_wrapper.hh.

Referenced by clear(), clear(), clear(), depth(), ensure_layer_views(), ensure_mip_views(), filter_mode(), free(), gpu_texture(), height(), is_array(), is_cube(), is_depth(), is_integer(), is_stencil(), is_valid(), layer_range_view(), mip_count(), operator GPUTexture *(), operator&(), pixel_count(), read(), size(), stencil_view(), swap(), Texture(), Texture(), Texture(), Texture(), Texture(), and width().

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

DRW_gpu_wrapper.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Texture() [1/7]

◆ Texture() [2/7]

◆ Texture() [3/7]

◆ Texture() [4/7]

◆ Texture() [5/7]

◆ Texture() [6/7]

◆ Texture() [7/7]

◆ ~Texture()

Member Function Documentation

◆ clear() [1/3]

◆ clear() [2/3]

◆ clear() [3/3]

◆ debug_clear()

◆ depth()

◆ ensure_1d()

◆ ensure_1d_array()

◆ ensure_2d()

◆ ensure_2d_array()

◆ ensure_3d()

◆ ensure_cube()

◆ ensure_cube_array()

◆ ensure_layer_views()

◆ ensure_mip_views()

◆ filter_mode()

◆ free()

◆ free_texture_views()

◆ gpu_texture()

◆ height()

◆ is_array()

◆ is_cube()

◆ is_depth()

◆ is_integer()

◆ is_stencil()

◆ is_valid()

◆ layer_range_view()

◆ layer_view()

◆ mip_count()

◆ mip_view()

◆ operator GPUTexture *()

◆ operator&()

◆ operator=()

◆ pixel_count()

◆ ptr()

◆ read()

◆ size()

◆ stencil_view()

◆ swap()

◆ width()

Member Data Documentation

◆ layer_range_view_

◆ layer_views_

◆ mip_views_

◆ name_

◆ stencil_view_

◆ tx_