1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
//! GPU sampler management.
//!
//! Samplers define how textures are sampled in shaders, including
//! filtering modes and addressing (wrapping) behavior.
use crate::backend::GpuBackend;
use crate::device::Device;
use crate::handles::SamplerHandle;
use crate::types::{ResourceAccess, ResourceCategory, ResourceHandle, SamplerDesc};
use anyhow::Result;
use std::sync::{Arc, Mutex};
/// A GPU sampler for texture sampling.
///
/// Samplers control how texture data is read in shaders:
/// - **Filtering**: How to interpolate between texels (nearest or linear)
/// - **Addressing**: What happens when UVs are outside [0, 1] (clamp, repeat, mirror)
///
/// # Example
///
/// ```rust,no_run
/// use goldy::{Device, Sampler, SamplerDesc, FilterMode, AddressMode};
///
/// fn create_sampler(device: &Device) -> anyhow::Result<Sampler> {
/// Sampler::new(device, &SamplerDesc {
/// mag_filter: FilterMode::Linear,
/// min_filter: FilterMode::Linear,
/// address_mode_u: AddressMode::Repeat,
/// address_mode_v: AddressMode::Repeat,
/// ..Default::default()
/// })
/// }
/// ```
pub struct Sampler {
_device: Device,
backend: Arc<Mutex<Box<dyn GpuBackend>>>,
pub(crate) handle: SamplerHandle,
bindless: Option<u32>,
}
impl Sampler {
/// Create a new sampler with the specified settings.
///
/// # Arguments
///
/// * `device` - The GPU device to create the sampler on
/// * `desc` - Sampler settings (filtering, addressing)
///
/// # Errors
///
/// Returns an error if GPU resource allocation fails.
pub fn new(device: &Device, desc: &SamplerDesc) -> Result<Self> {
tracing::debug!(
mag_filter = ?desc.mag_filter,
min_filter = ?desc.min_filter,
address_u = ?desc.address_mode_u,
"Creating sampler"
);
let (handle, bindless) = {
let mut backend = device.inner.backend.lock().unwrap();
let handle = backend.create_sampler(device.inner.handle, desc)?;
let bindless = backend.sampler_bindless_index(handle);
(handle, bindless)
};
Ok(Self {
_device: device.clone(),
backend: Arc::clone(&device.inner.backend),
handle,
bindless,
})
}
/// Create a sampler with default settings (nearest filtering, clamp to edge).
pub fn default_sampler(device: &Device) -> Result<Self> {
Self::new(device, &SamplerDesc::default())
}
/// Create a sampler with linear filtering and clamp to edge addressing.
///
/// This is a common configuration for smooth texture sampling.
pub fn linear(device: &Device) -> Result<Self> {
use crate::types::FilterMode;
Self::new(
device,
&SamplerDesc {
mag_filter: FilterMode::Linear,
min_filter: FilterMode::Linear,
mipmap_filter: FilterMode::Linear,
..Default::default()
},
)
}
/// Create a sampler with nearest filtering and clamp to edge addressing.
///
/// This preserves hard pixel edges (useful for pixel art).
pub fn nearest(device: &Device) -> Result<Self> {
use crate::types::FilterMode;
Self::new(
device,
&SamplerDesc {
mag_filter: FilterMode::Nearest,
min_filter: FilterMode::Nearest,
mipmap_filter: FilterMode::Nearest,
..Default::default()
},
)
}
/// Create a sampler with linear filtering and repeat addressing.
///
/// This is common for tiling textures.
pub fn linear_repeat(device: &Device) -> Result<Self> {
use crate::types::{AddressMode, FilterMode};
Self::new(
device,
&SamplerDesc {
mag_filter: FilterMode::Linear,
min_filter: FilterMode::Linear,
mipmap_filter: FilterMode::Linear,
address_mode_u: AddressMode::Repeat,
address_mode_v: AddressMode::Repeat,
address_mode_w: AddressMode::Repeat,
max_anisotropy: 1.0,
compare: None,
lod_min_clamp: 0.0,
lod_max_clamp: 32.0,
},
)
}
/// Get the backend handle for this sampler.
pub fn gpu_handle(&self) -> SamplerHandle {
self.handle
}
/// Resource descriptor index for how this sampler will be accessed in the current dispatch.
///
/// Crate-internal: the public binding path is [`Self::handle`] / scheme `with_parcel`.
pub(crate) fn resource_index(&self, access: ResourceAccess) -> Option<u32> {
match access {
ResourceAccess::Read => self.bindless,
ResourceAccess::Write | ResourceAccess::ReadWrite => None,
}
}
/// Opaque typed resource descriptor identity for validation and retention checks.
pub fn handle(&self, access: ResourceAccess) -> Option<ResourceHandle> {
self.resource_index(access)
.map(|i| ResourceHandle::new(ResourceCategory::Sampler, i))
}
}
impl Drop for Sampler {
fn drop(&mut self) {
tracing::trace!("Destroying sampler");
if let Ok(mut backend) = self.backend.lock() {
backend.destroy_sampler(self.handle);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::backend::mock::MockBackend;
use crate::types::{AddressMode, FilterMode};
fn create_test_device() -> Device {
Device::from_backend(Box::new(MockBackend::new())).unwrap()
}
#[test]
fn test_sampler_creation() {
let device = create_test_device();
let _sampler = Sampler::new(&device, &SamplerDesc::default()).unwrap();
}
#[test]
fn test_sampler_default() {
let device = create_test_device();
let _sampler = Sampler::default_sampler(&device).unwrap();
}
#[test]
fn test_sampler_linear() {
let device = create_test_device();
let _sampler = Sampler::linear(&device).unwrap();
}
#[test]
fn test_sampler_nearest() {
let device = create_test_device();
let _sampler = Sampler::nearest(&device).unwrap();
}
#[test]
fn test_sampler_linear_repeat() {
let device = create_test_device();
let _sampler = Sampler::linear_repeat(&device).unwrap();
}
#[test]
fn test_sampler_custom() {
let device = create_test_device();
let desc = SamplerDesc {
mag_filter: FilterMode::Linear,
min_filter: FilterMode::Nearest,
mipmap_filter: FilterMode::Linear,
address_mode_u: AddressMode::MirrorRepeat,
address_mode_v: AddressMode::ClampToEdge,
..Default::default()
};
let _sampler = Sampler::new(&device, &desc).unwrap();
}
}