Skip to content

Commit 9c77d87

Browse files
Update docs
1 parent c3e7ebd commit 9c77d87

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

chowdsp_convolution.h

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ void create_ir (const struct Convolution_Config*, struct IR_Uniform*, const floa
130130
* Creates a mono IR of a given size.
131131
* The IR will be filled with zeros.
132132
*
133-
* See the requirements for `place_data` in `create_ir()`.
133+
* See the requirements for `place_data` for `create_ir()`.
134134
*/
135135
void create_zero_ir (const struct Convolution_Config*, struct IR_Uniform*, int ir_num_samples, void* place_data
136136
#ifdef __cplusplus
@@ -157,6 +157,8 @@ size_t multichannel_ir_bytes_required (int max_block_size, int ir_num_samples, i
157157
* The fft_scratch pointer should point to
158158
* an array of config->fft_size floats, and should
159159
* have 64-byte alignment.
160+
*
161+
* See the requirements for `place_data` for `create_ir()`.
160162
*/
161163
void create_multichannel_ir (const struct Convolution_Config*, struct IR_Uniform*, const float* const* ir, int ir_num_samples, int num_channels, float* fft_scratch, void* place_data
162164
#ifdef __cplusplus
@@ -167,6 +169,8 @@ void create_multichannel_ir (const struct Convolution_Config*, struct IR_Uniform
167169
/**
168170
* Creates a multi-channel IR of a given size.
169171
* The IR will be filled with zeros.
172+
*
173+
* See the requirements for `place_data` for `create_ir()`.
170174
*/
171175
void create_zero_multichannel_ir (const struct Convolution_Config*, struct IR_Uniform*, int ir_num_samples, int num_channels, void* place_data
172176
#ifdef __cplusplus
@@ -193,6 +197,10 @@ size_t process_state_bytes_required (int max_block_size, int ir_num_samples);
193197
/**
194198
* Creates a process state object for a given IR.
195199
* The process state will be created to process the same number of channels as the IR contains.
200+
*
201+
* If `place_data` is provided, the state will be constructed in-place.
202+
* Otherwise, memory will be allocated, and the user must call `destroy_process_state()`
203+
* to free that memory. `place_data` should be aligned to 64 bytes.
196204
*/
197205
void create_process_state (const struct Convolution_Config*, const struct IR_Uniform*, struct Process_Uniform_State*, void* place_data
198206
#ifdef __cplusplus
@@ -209,6 +217,8 @@ size_t multichannel_process_state_bytes_required (int max_block_size, int ir_num
209217
/**
210218
* Creates a process state object for a given IR, with a specific number of channels.
211219
* This is useful for convolving a monophonic IR with multiple channels.
220+
*
221+
* See the requirements for `place_data` for `create_process_state()`.
212222
*/
213223
void create_multichannel_process_state (const struct Convolution_Config*, const struct IR_Uniform*, struct Process_Uniform_State*, int num_channels, void* place_data
214224
#ifdef __cplusplus

0 commit comments

Comments
 (0)