Blender V5.3
gpu_texture_pool.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2021 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BKE_global.hh"
10#include "BLI_string.hh"
11
12#include "GPU_texture.hh"
13#include "GPU_texture_pool.hh"
14
15#include "gpu_backend.hh"
18
19#include "fmt/format.h"
20
21namespace blender::gpu {
22
24{
26 return *unwrap(GPU_context_active_get())->texture_pool;
27}
28
30{
31 for (TextureHandle tex : acquired_) {
32 GPU_texture_free(tex.texture);
33 }
34 for (TextureHandle tex : pool_) {
35 GPU_texture_free(tex.texture);
36 }
37}
38
40 int mip_len,
41 GPUTextureType type,
42 TextureFormat format,
43 eGPUTextureUsage usage,
44 const char * /* name */)
45{
46 /* Determine actual mipmap depth. */
47 int mip_len_max = 1 + floorf(log2f(std::max({extent.x, extent.y, extent.z})));
48 mip_len = min_ii(mip_len, mip_len_max);
49
50 /* Append format view flag for all pool textures. */
51 /* TODO(not_mark): this flag can likely be removed from TexturePoolImpl entirely. */
53
54 /* Search pool for compatible available texture first. */
55 int64_t match_index = -1;
56 for (uint64_t i : pool_.index_range()) {
57 Texture *tex = pool_[i].texture;
58
59 auto tex_args = std::tuple(tex->format_get(),
60 tex->type_get(),
61 tex->width_get(),
62 tex->height_get(),
63 tex->depth_get(),
64 tex->mip_count());
65 if (std::tie(format, type, UNPACK3(extent), mip_len) != tex_args) {
66 continue;
67 }
68
69 eGPUTextureUsage tex_usage = tex->usage_get();
70 if ((tex_usage & usage) == usage) {
71 /* If a texture has overlapping usage flags, keep its index for now. */
72 match_index = i;
73 }
74 if (tex_usage == usage) {
75 /* If a texture has matching usage flags, there is no better candidate. */
76 match_index = i;
77 break;
78 }
79 }
80
81 /* If a compatible pool texture was found, acquire and return it. */
82 if (match_index != -1) {
83 TextureHandle handle = {pool_[match_index].texture};
84 acquired_.add(handle);
85 pool_.remove_and_reorder(match_index);
86 return handle.texture;
87 }
88
89 /* Generate debug label name, if one isn't passed in `name`. TexturePoolImpl ignores the
90 * name argument, as returned textures do not shadow/view/abstract the underlying texture. */
91 std::string name_str;
92 if (G.debug & G_DEBUG_GPU) {
93 name_str = fmt::format("TexFromPool_{}", pool_.size());
94 }
95
96 /* Otherwise, allocate a new texture of the specified type. */
97 TextureHandle handle = {GPUBackend::get()->texture_alloc(name_str.c_str())};
98 handle.texture->usage_set(usage);
99 bool init_result = false;
100 switch (type) {
101 case GPU_TEXTURE_1D:
103 init_result = handle.texture->init_1D(extent.x, extent.y, mip_len, format);
104 break;
105 case GPU_TEXTURE_2D:
107 init_result = handle.texture->init_2D(extent.x, extent.y, extent.z, mip_len, format);
108 break;
109 case GPU_TEXTURE_3D:
110 init_result = handle.texture->init_3D(extent.x, extent.y, extent.z, mip_len, format);
111 break;
112 case GPU_TEXTURE_CUBE:
114 init_result = handle.texture->init_cubemap(extent.x, extent.y, mip_len, format);
115 break;
116 default:
118 break;
119 }
120 UNUSED_VARS_NDEBUG(init_result);
121 BLI_assert(init_result);
122
123 acquired_.add(handle);
124 return handle.texture;
125} // namespace blender::gpu
126
128{
129 BLI_assert_msg(acquired_.contains({tex}),
130 "Unacquired texture passed to TexturePool::release_texture()");
131 acquired_.remove({tex});
132 pool_.append({tex});
133}
134
136{
137 BLI_assert_msg(acquired_.contains({tex}),
138 "Unacquired texture passed to TexturePool::offset_users_count()");
139 int users_count = acquired_.lookup_key({tex}).users_count;
140 acquired_.add_overwrite({tex, users_count + offset, 0});
141}
142
143void TexturePoolImpl::reset(bool force_free)
144{
145#ifndef NDEBUG
146 /* Iterate acquired textures, and ensure the internal counter equals 0; otherwise
147 * this indicates a missing `::retain()` or `::release()`. */
148 for (const TextureHandle &tex : acquired_) {
149 BLI_assert_msg(tex.users_count == 0,
150 "Missing texture release/retain. Likely TextureFromPool::release(), "
151 "TextureFromPool::retain() or TexturePool::release_texture().");
152 }
153#endif
154
155 /* Reverse iterate pool textures, to make sure we only reorder known good handles. */
156 for (int i = pool_.size() - 1; i >= 0; i--) {
157 TextureHandle &tex = pool_[i];
158 if (tex.unused_cycles_count >= max_unused_cycles_ || force_free) {
159 GPU_texture_free(tex.texture);
160 pool_.remove_and_reorder(i);
161 }
162 else {
163 tex.unused_cycles_count++;
164 }
165 }
166}
167} // namespace blender::gpu
#define BLI_assert_unreachable()
#define UNUSED_VARS_NDEBUG(...)
#define UNPACK3(a)
#define BLI_assert_msg(a, msg)
virtual Texture * texture_alloc(const char *name)=0
static GPUBackend * get()
void offset_users_count(Texture *tex, int offset) override
void release_texture(Texture *tex) override
Texture * acquire_texture_impl(int3 extent, int mip_len, GPUTextureType type, TextureFormat format, eGPUTextureUsage usage=GPU_TEXTURE_USAGE_GENERAL, const char *name=nullptr) override
void reset(bool force_free=false) override
static TexturePool & get()
bool init_1D(int w, int layers, int mip_len, TextureFormat format)
GPUTextureType type_get() const
eGPUTextureUsage usage_get() const
bool init_cubemap(int w, int layers, int mip_len, TextureFormat format)
bool init_2D(int w, int h, int layers, int mip_len, TextureFormat format)
bool init_3D(int w, int h, int d, int mip_len, TextureFormat format)
TextureFormat format_get() const
void usage_set(eGPUTextureUsage usage_flags)
BLI_INLINE MTLTexture * unwrap(Texture *tex)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
unsigned __int64 uint64_t
Definition BKE_text.h:91
__int64 int64_t
Definition BKE_text.h:90
Global G
Definition blender.cc:57
VecBase< int32_t, 3 > int3
@ GPU_TEXTURE_USAGE_FORMAT_VIEW
void GPU_texture_free(gpu::Texture *texture)
MINLINE int min_ii(int a, int b)
GPUContext * GPU_context_active_get()
#define floorf