looklook 0.5.0

Descriptive signal synthesiser.
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

// Copyright 2026 Gabriel Bjørnager Jensen.
//
// This file is part of LOOKLOOK.
//
// LOOKLOOK is free software: you can redistribute
// it and/or modify it under the terms of the GNU
// Affero General Public License as published by
// the Free Software Foundation, either version 3
// of the License, or (at your option) any later
// version.
//
// LOOKLOOK is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Affero General Public License for more details.
//
// You should have received a copy of the GNU Af-
// fero General Public License along with LOOKLOOK.
// If not, see <https://www.gnu.org/licenses/>.

//! The [`mode::Builder`] type.
//!
//! [`mode::Builder`]: Builder

use crate::mode::Mode;

/// A mode builder.
#[must_use]
#[derive(Debug)]
#[derive_const(Clone, Default)]
pub struct Builder {
	/// The sampling depth.
	pub sample_depth: Option<u32>,

	/// The amount of channels.
	pub channel_count: Option<u32>,

	/// The frame height.
	pub width: Option<u32>,

	/// The frame height.
	pub height: Option<u32>,

	/// The total count of frames.
	pub duration: Option<u64>,
}

impl Builder {
	/// Constructs a new mode builder.
	#[inline]
	pub const fn new() -> Self {
		Default::default()
	}

	/// Specifies the sampling depth.
	///
	/// # Panics
	///
	/// This method will panic if the depth is already
	/// specified.
	#[inline]
	pub const fn sample_depth(mut self, sample_depth: u32) -> Self {
		assert!(
			self.sample_depth.is_none(),
			"sampling depth is already specified",
		);

		self.sample_depth = Some(sample_depth);
		self
	}

	/// Specifies the channel count.
	///
	/// # Panics
	///
	/// This method will panic if the channel count is
	/// already specified.
	#[inline]
	pub const fn channel_count(mut self, channel_count: u32) -> Self {
		assert!(
			self.channel_count.is_none(),
			"channel count is already specified",
		);

		self.channel_count = Some(channel_count);
		self
	}

	/// Specifies the frame width.
	///
	/// For non-video renders, this value should be `1`.
	///
	/// # Panics
	///
	/// This method will panic if the frame width is
	/// already specified.
	#[inline]
	pub const fn width(mut self, width: u32) -> Self {
		assert!(
			self.width.is_none(),
			"frame width is already specified",
		);

		self.width = Some(width);
		self
	}

	/// Specifies the frame height.
	///
	/// For non-video renders, this value should be `1`.
	///
	/// # Panics
	///
	/// This method will panic if the frame height is
	/// already specified.
	#[inline]
	pub const fn height(mut self, height: u32) -> Self {
		assert!(
			self.height.is_none(),
			"frame height is already specified",
		);

		self.height = Some(height);
		self
	}

	/// Specifies the render duration.
	///
	/// The provided value is measured in count of
	/// frames. For non-video renders, this should
	/// simply be the total sample count.
	///
	/// # Panics
	///
	/// This method will panic if the duration is
	/// already specified.
	#[inline]
	pub const fn duration(mut self, duration: u64) -> Self {
		assert!(
			self.duration.is_none(),
			"frame height is already specified",
		);

		self.duration = Some(duration);
		self
	}

	/// Builds the mode.
	///
	/// # Panics
	///
	/// This method will panic in the following cases:
	///
	/// * `sample_depth` is unspecified, zero, or
	///   greater than `4`;
	/// * `channel_count` is unspecified, zero, or
	///   greater than `64`;
	/// * `width` is unspecified, zero, or greater than
	///   `32768`;
	/// * `height` is unspecified, zero, or greater than
	///   `32768`;
	/// * `duration` is unspecified;
	/// * The total sample count is greater than
	///   [`isize::MAX`].
	#[inline]
	#[must_use]
	pub const fn build(self) -> Mode {
		Mode::from_builder(self)
	}
}