diff options
Diffstat (limited to 'src/audio_core/hle/pipe.h')
| -rw-r--r-- | src/audio_core/hle/pipe.h | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/src/audio_core/hle/pipe.h b/src/audio_core/hle/pipe.h index 64d97f8ba..b714c0496 100644 --- a/src/audio_core/hle/pipe.h +++ b/src/audio_core/hle/pipe.h | |||
| @@ -24,10 +24,14 @@ enum class DspPipe { | |||
| 24 | constexpr size_t NUM_DSP_PIPE = 8; | 24 | constexpr size_t NUM_DSP_PIPE = 8; |
| 25 | 25 | ||
| 26 | /** | 26 | /** |
| 27 | * Read a DSP pipe. | 27 | * Reads `length` bytes from the DSP pipe identified with `pipe_number`. |
| 28 | * @param pipe_number The Pipe ID | 28 | * @note Can read up to the maximum value of a u16 in bytes (65,535). |
| 29 | * @param length How much data to request. | 29 | * @note IF an error is encoutered with either an invalid `pipe_number` or `length` value, an empty vector will be returned. |
| 30 | * @return The data read from the pipe. The size of this vector can be less than the length requested. | 30 | * @note IF `length` is set to 0, an empty vector will be returned. |
| 31 | * @note IF `length` is greater than the amount of data available, this function will only read the available amount. | ||
| 32 | * @param pipe_number a `DspPipe` | ||
| 33 | * @param length the number of bytes to read. The max is 65,535 (max of u16). | ||
| 34 | * @returns a vector of bytes from the specified pipe. On error, will be empty. | ||
| 31 | */ | 35 | */ |
| 32 | std::vector<u8> PipeRead(DspPipe pipe_number, u32 length); | 36 | std::vector<u8> PipeRead(DspPipe pipe_number, u32 length); |
| 33 | 37 | ||