Blender V5.3
GPU_texture_pool.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#pragma once
13
15#include "BLI_set.hh"
16#include "BLI_vector.hh"
17#include "GPU_texture.hh"
18
19namespace blender::gpu {
20
22 public:
23 virtual ~TexturePool() = default;
24
25 /* Return the texture pool from the active GPUContext.
26 * Only valid if a context is active. */
27 static TexturePool &get();
28
29 /* Acquire a texture of a particular type from the pool. */
30 virtual Texture *acquire_texture_1d(int extent,
31 int mip_len,
32 TextureFormat format,
33 eGPUTextureUsage usage,
34 const char *name = nullptr) = 0;
35 virtual Texture *acquire_texture_1d_array(int extent,
36 int layer_len,
37 int mip_len,
38 TextureFormat format,
39 eGPUTextureUsage usage,
40 const char *name = nullptr) = 0;
42 int mip_len,
43 TextureFormat format,
44 eGPUTextureUsage usage,
45 const char *name = nullptr) = 0;
47 int layer_len,
48 int mip_len,
49 TextureFormat format,
50 eGPUTextureUsage usage,
51 const char *name = nullptr) = 0;
53 int mip_len,
54 TextureFormat format,
55 eGPUTextureUsage usage,
56 const char *name = nullptr) = 0;
57 virtual Texture *acquire_texture_cube(int extent,
58 int mip_len,
59 TextureFormat format,
60 eGPUTextureUsage usage,
61 const char *name = nullptr) = 0;
63 int layer_len,
64 int mip_len,
65 TextureFormat format,
66 eGPUTextureUsage usage,
67 const char *name = nullptr) = 0;
68
69 /* Release the texture back into the pool so it can be reused. */
70 virtual void release_texture(Texture *tex) = 0;
71
72 /* Validate acquired texture counters and release unused textures.
73 * If `force_free` is true, free unused texture memory inside the pool. */
74 virtual void reset(bool force_free = false) = 0;
75
76 /* Modify the internal counter of an acquired texture.
77 * Used by `TextureFromPool::retain()` in `DRW_gpu_wrapper.hh`. */
78 virtual void offset_users_count(Texture *tex, int offset) = 0;
79};
80
81} // namespace blender::gpu
virtual void reset(bool force_free=false)=0
virtual Texture * acquire_texture_1d_array(int extent, int layer_len, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
virtual Texture * acquire_texture_2d_array(int2 extent, int layer_len, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
virtual Texture * acquire_texture_1d(int extent, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
virtual ~TexturePool()=default
virtual void release_texture(Texture *tex)=0
virtual Texture * acquire_texture_cube_array(int extent, int layer_len, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
virtual Texture * acquire_texture_2d(int2 extent, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
virtual void offset_users_count(Texture *tex, int offset)=0
virtual Texture * acquire_texture_3d(int3 extent, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
static TexturePool & get()
virtual Texture * acquire_texture_cube(int extent, int mip_len, TextureFormat format, eGPUTextureUsage usage, const char *name=nullptr)=0
VecBase< int32_t, 2 > int2
VecBase< int32_t, 3 > int3