DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add to and clean up Y2R documentation.

Browse Source
This commit is contained in:
Steven Smith 2015-11-21 09:26:50 -08:00
parent 9b57720cee
commit 827bbba993
1 changed files with 126 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
libctru/include/3ds/services/y2r.h
View File

@ -26,21 +26,19 @@ typedef enum
*/ */
typedef enum typedef enum
{ {
OUTPUT_RGB_32 = 0x0, ///< The alpha component is the 8-bit value set by @ref Y2RU_SetAlpha OUTPUT_RGB_32 = 0x0, ///< 32-bit RGBA8888. The alpha component is the 8-bit value set by @ref Y2RU_SetAlpha
OUTPUT_RGB_24 = 0x1, OUTPUT_RGB_24 = 0x1, ///< 24-bit RGB888.
OUTPUT_RGB_16_555 = 0x2, ///< The alpha bit is the 7th bit of the alpha value set by @ref Y2RU_SetAlpha OUTPUT_RGB_16_555 = 0x2, ///< 16-bit RGBA5551. The alpha bit is the 7th bit of the alpha value set by @ref Y2RU_SetAlpha
OUTPUT_RGB_16_565 = 0x3, OUTPUT_RGB_16_565 = 0x3, ///< 16-bit RGB565.
} Y2RU_OutputFormat; } Y2RU_OutputFormat;
/** /// Rotation to be applied to the output.
* @brief Rotation to be applied to the output
*/
typedef enum typedef enum
{ {
ROTATION_NONE = 0x0, ROTATION_NONE = 0x0, ///< No rotation.
ROTATION_CLOCKWISE_90 = 0x1, ROTATION_CLOCKWISE_90 = 0x1, ///< Clockwise 90 degrees.
ROTATION_CLOCKWISE_180 = 0x2, ROTATION_CLOCKWISE_180 = 0x2, ///< Clockwise 180 degrees.
ROTATION_CLOCKWISE_270 = 0x3, ROTATION_CLOCKWISE_270 = 0x3, ///< Clockwise 270 degrees.
} Y2RU_Rotation; } Y2RU_Rotation;
/** /**
@ -70,14 +68,14 @@ typedef enum
*/ */
typedef struct typedef struct
{ {
u16 rgb_Y; u16 rgb_Y; ///< RGB per unit Y.
u16 r_V; u16 r_V; ///< Red per unit V.
u16 g_V; u16 g_V; ///< Green per unit V.
u16 g_U; u16 g_U; ///< Green per unit U.
u16 b_U; u16 b_U; ///< Blue per unit U.
u16 r_offset; u16 r_offset; ///< Red offset.
u16 g_offset; u16 g_offset; ///< Green offset.
u16 b_offset; u16 b_offset; ///< Blue offset.
} Y2RU_ColorCoefficients; } Y2RU_ColorCoefficients;
/** /**
@ -97,7 +95,6 @@ typedef enum
* @brief Structure used to configure all parameters at once. * @brief Structure used to configure all parameters at once.
* *
* You can send a batch of configuration parameters using this structure and @ref Y2RU_SetConversionParams. * You can send a batch of configuration parameters using this structure and @ref Y2RU_SetConversionParams.
*
*/ */
typedef struct typedef struct
{ {
@ -108,32 +105,29 @@ typedef struct
s16 input_line_width; ///< Value passed to @ref Y2RU_SetInputLineWidth s16 input_line_width; ///< Value passed to @ref Y2RU_SetInputLineWidth
s16 input_lines; ///< Value passed to @ref Y2RU_SetInputLines s16 input_lines; ///< Value passed to @ref Y2RU_SetInputLines
Y2RU_StandardCoefficient standard_coefficient : 8; ///< Value passed to @ref Y2RU_SetStandardCoefficient Y2RU_StandardCoefficient standard_coefficient : 8; ///< Value passed to @ref Y2RU_SetStandardCoefficient
u8 unused; u8 unused; ///< Unused.
u16 alpha; ///< Value passed to @ref Y2RU_SetAlpha u16 alpha; ///< Value passed to @ref Y2RU_SetAlpha
} Y2RU_ConversionParams; } Y2RU_ConversionParams;
/** /// Dithering weights.
* @brief Dithering weights
*
*/
typedef struct typedef struct
{ {
u16 w0_xEven_yEven; u16 w0_xEven_yEven; ///< Weight 0 for even X, even Y.
u16 w0_xOdd_yEven; u16 w0_xOdd_yEven; ///< Weight 0 for odd X, even Y.
u16 w0_xEven_yOdd; u16 w0_xEven_yOdd; ///< Weight 0 for even X, odd Y.
u16 w0_xOdd_yOdd; u16 w0_xOdd_yOdd; ///< Weight 0 for odd X, odd Y.
u16 w1_xEven_yEven; u16 w1_xEven_yEven; ///< Weight 1 for even X, even Y.
u16 w1_xOdd_yEven; u16 w1_xOdd_yEven; ///< Weight 1 for odd X, even Y.
u16 w1_xEven_yOdd; u16 w1_xEven_yOdd; ///< Weight 1 for even X, odd Y.
u16 w1_xOdd_yOdd; u16 w1_xOdd_yOdd; ///< Weight 1 for odd X, odd Y.
u16 w2_xEven_yEven; u16 w2_xEven_yEven; ///< Weight 2 for even X, even Y.
u16 w2_xOdd_yEven; u16 w2_xOdd_yEven; ///< Weight 2 for odd X, even Y.
u16 w2_xEven_yOdd; u16 w2_xEven_yOdd; ///< Weight 2 for even X, odd Y.
u16 w2_xOdd_yOdd; u16 w2_xOdd_yOdd; ///< Weight 2 for odd X, odd Y.
u16 w3_xEven_yEven; u16 w3_xEven_yEven; ///< Weight 3 for even X, even Y.
u16 w3_xOdd_yEven; u16 w3_xOdd_yEven; ///< Weight 3 for odd X, even Y.
u16 w3_xEven_yOdd; u16 w3_xEven_yOdd; ///< Weight 3 for even X, odd Y.
u16 w3_xOdd_yOdd; u16 w3_xOdd_yOdd; ///< Weight 3 for odd X, odd Y.
} Y2RU_DitheringWeightParams; } Y2RU_DitheringWeightParams;
/** /**
@ -152,24 +146,35 @@ void y2rExit(void);
/** /**
* @brief Used to configure the input format. * @brief Used to configure the input format.
* @param format Input format to use.
* *
* @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters. * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.
*/ */
Result Y2RU_SetInputFormat(Y2RU_InputFormat format); Result Y2RU_SetInputFormat(Y2RU_InputFormat format);
/**
* @brief Gets the configured input format.
* @param format Pointer to output the input format to.
*/
Result Y2RU_GetInputFormat(Y2RU_InputFormat* format); Result Y2RU_GetInputFormat(Y2RU_InputFormat* format);
/** /**
* @brief Used to configure the output format. * @brief Used to configure the output format.
* @param format Output format to use.
* *
* @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters. * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.
*/ */
Result Y2RU_SetOutputFormat(Y2RU_OutputFormat format); Result Y2RU_SetOutputFormat(Y2RU_OutputFormat format);
/**
* @brief Gets the configured output format.
* @param format Pointer to output the output format to.
*/
Result Y2RU_GetOutputFormat(Y2RU_OutputFormat* format); Result Y2RU_GetOutputFormat(Y2RU_OutputFormat* format);
/** /**
* @brief Used to configure the rotation of the output. * @brief Used to configure the rotation of the output.
* @param rotation Rotation to use.
* *
* It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width. * It seems to apply the rotation per batch of 8 lines, so the output will be (height/8) images of size 8 x width.
* *
@ -177,25 +182,48 @@ Result Y2RU_GetOutputFormat(Y2RU_OutputFormat* format);
*/ */
Result Y2RU_SetRotation(Y2RU_Rotation rotation); Result Y2RU_SetRotation(Y2RU_Rotation rotation);
/**
* @brief Gets the configured rotation.
* @param rotation Pointer to output the rotation to.
*/
Result Y2RU_GetRotation(Y2RU_Rotation* rotation); Result Y2RU_GetRotation(Y2RU_Rotation* rotation);
/** /**
* @brief Used to configure the alignment of the output buffer. * @brief Used to configure the alignment of the output buffer.
* @param alignment Alignment to use.
* *
* @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters. * @note Prefer using @ref Y2RU_SetConversionParams if you have to set multiple parameters.
*/ */
Result Y2RU_SetBlockAlignment(Y2RU_BlockAlignment alignment); Result Y2RU_SetBlockAlignment(Y2RU_BlockAlignment alignment);
/**
* @brief Gets the configured alignment.
* @param alignment Pointer to output the alignment to.
*/
Result Y2RU_GetBlockAlignment(Y2RU_BlockAlignment* alignment); Result Y2RU_GetBlockAlignment(Y2RU_BlockAlignment* alignment);
///Sets the usage of spacial dithering /**
* @brief Sets whether to use spacial dithering.
* @param enable Whether to use spacial dithering.
*/
Result Y2RU_SetSpacialDithering(bool enable); Result Y2RU_SetSpacialDithering(bool enable);
/**
* @brief Gets whether to use spacial dithering.
* @param enable Pointer to output the spacial dithering state to.
*/
Result Y2RU_GetSpacialDithering(bool* enabled); Result Y2RU_GetSpacialDithering(bool* enabled);
///Sets the usage of temporal dithering /**
* @brief Sets whether to use temporal dithering.
* @param enable Whether to use temporal dithering.
*/
Result Y2RU_SetTemporalDithering(bool enable); Result Y2RU_SetTemporalDithering(bool enable);
/**
* @brief Gets whether to use temporal dithering.
* @param enable Pointer to output the temporal dithering state to.
*/
Result Y2RU_GetTemporalDithering(bool* enabled); Result Y2RU_GetTemporalDithering(bool* enabled);
@ -207,6 +235,10 @@ Result Y2RU_GetTemporalDithering(bool* enabled);
*/ */
Result Y2RU_SetInputLineWidth(u16 line_width); Result Y2RU_SetInputLineWidth(u16 line_width);
/**
* @brief Gets the configured input line width.
* @param line_width Pointer to output the line width to.
*/
Result Y2RU_GetInputLineWidth(u16* line_width); Result Y2RU_GetInputLineWidth(u16* line_width);
/** /**
@ -220,10 +252,15 @@ Result Y2RU_GetInputLineWidth(u16* line_width);
*/ */
Result Y2RU_SetInputLines(u16 num_lines); Result Y2RU_SetInputLines(u16 num_lines);
/**
* @brief Gets the configured number of input lines.
* @param num_lines Pointer to output the input lines to.
*/
Result Y2RU_GetInputLines(u16* num_lines); Result Y2RU_GetInputLines(u16* num_lines);
/** /**
* @brief Used to configure the color conversion formula. * @brief Used to configure the color conversion formula.
* @param coefficients Coefficients to use.
* *
* See @ref Y2RU_ColorCoefficients for more information about the coefficients. * See @ref Y2RU_ColorCoefficients for more information about the coefficients.
* *
@ -231,10 +268,15 @@ Result Y2RU_GetInputLines(u16* num_lines);
*/ */
Result Y2RU_SetCoefficients(const Y2RU_ColorCoefficients* coefficients); Result Y2RU_SetCoefficients(const Y2RU_ColorCoefficients* coefficients);
/**
* @brief Gets the configured color coefficients.
* @param num_lines Pointer to output the coefficients to.
*/
Result Y2RU_GetCoefficients(Y2RU_ColorCoefficients* coefficients); Result Y2RU_GetCoefficients(Y2RU_ColorCoefficients* coefficients);
/** /**
* @brief Used to configure the color conversion formula with ITU stantards coefficients. * @brief Used to configure the color conversion formula with ITU stantards coefficients.
* @param coefficient Standard coefficient to use.
* *
* See @ref Y2RU_ColorCoefficients for more information about the coefficients. * See @ref Y2RU_ColorCoefficients for more information about the coefficients.
* *
@ -242,7 +284,11 @@ Result Y2RU_GetCoefficients(Y2RU_ColorCoefficients* coefficients);
*/ */
Result Y2RU_SetStandardCoefficient(Y2RU_StandardCoefficient coefficient); Result Y2RU_SetStandardCoefficient(Y2RU_StandardCoefficient coefficient);
///Retrieves the coeeficients associated to the given standard /**
* @brief Gets the color coefficient parameters of a standard coefficient.
* @param coefficients Pointer to output the coefficients to.
* @param standardCoeff Standard coefficient to check.
*/
Result Y2RU_GetStandardCoefficient(Y2RU_ColorCoefficients* coefficients, Y2RU_StandardCoefficient standardCoeff); Result Y2RU_GetStandardCoefficient(Y2RU_ColorCoefficients* coefficients, Y2RU_StandardCoefficient standardCoeff);
/** /**
@ -253,6 +299,10 @@ Result Y2RU_GetStandardCoefficient(Y2RU_ColorCoefficients* coefficients, Y2RU_St
*/ */
Result Y2RU_SetAlpha(u16 alpha); Result Y2RU_SetAlpha(u16 alpha);
/**
* @brief Gets the configured output alpha value.
* @param alpha Pointer to output the alpha value to.
*/
Result Y2RU_GetAlpha(u16* alpha); Result Y2RU_GetAlpha(u16* alpha);
/** /**
@ -267,6 +317,10 @@ Result Y2RU_GetAlpha(u16* alpha);
*/ */
Result Y2RU_SetTransferEndInterrupt(bool should_interrupt); Result Y2RU_SetTransferEndInterrupt(bool should_interrupt);
/**
* @brief Gets whether the transfer end interrupt is enabled.
* @param should_interrupt Pointer to output the interrupt state to.
*/
Result Y2RU_GetTransferEndInterrupt(bool* should_interrupt); Result Y2RU_GetTransferEndInterrupt(bool* should_interrupt);
/** /**
@ -360,7 +414,7 @@ Result Y2RU_SetReceiving(void* dst_buf, u32 image_size, s16 transfer_unit, s16 t
/** /**
* @brief Checks if the DMA has finished sending the Y buffer. * @brief Checks if the DMA has finished sending the Y buffer.
* @param is_done pointer to the boolean that will hold the result * @param is_done Pointer to the boolean that will hold the result.
* *
* True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY. * True if the DMA has finished transferring the Y plane, false otherwise. To be used with @ref Y2RU_SetSendingY.
*/ */
@ -368,7 +422,7 @@ Result Y2RU_IsDoneSendingY(bool* is_done);
/** /**
* @brief Checks if the DMA has finished sending the U buffer. * @brief Checks if the DMA has finished sending the U buffer.
* @param is_done pointer to the boolean that will hold the result * @param is_done Pointer to the boolean that will hold the result.
* *
* True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU. * True if the DMA has finished transferring the U plane, false otherwise. To be used with @ref Y2RU_SetSendingU.
*/ */
@ -376,7 +430,7 @@ Result Y2RU_IsDoneSendingU(bool* is_done);
/** /**
* @brief Checks if the DMA has finished sending the V buffer. * @brief Checks if the DMA has finished sending the V buffer.
* @param is_done pointer to the boolean that will hold the result * @param is_done Pointer to the boolean that will hold the result.
* *
* True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV. * True if the DMA has finished transferring the V plane, false otherwise. To be used with @ref Y2RU_SetSendingV.
*/ */
@ -384,7 +438,7 @@ Result Y2RU_IsDoneSendingV(bool* is_done);
/** /**
* @brief Checks if the DMA has finished sending the YUYV buffer. * @brief Checks if the DMA has finished sending the YUYV buffer.
* @param is_done pointer to the boolean that will hold the result * @param is_done Pointer to the boolean that will hold the result.
* *
* True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV. * True if the DMA has finished transferring the YUYV buffer, false otherwise. To be used with @ref Y2RU_SetSendingYUYV.
*/ */
@ -392,20 +446,27 @@ Result Y2RU_IsDoneSendingYUYV(bool* is_done);
/** /**
* @brief Checks if the DMA has finished sending the converted result. * @brief Checks if the DMA has finished sending the converted result.
* @param is_done pointer to the boolean that will hold the result * @param is_done Pointer to the boolean that will hold the result.
* *
* True if the DMA has finished transferring data to your destination buffer, false otherwise. * True if the DMA has finished transferring data to your destination buffer, false otherwise.
*/ */
Result Y2RU_IsDoneReceiving(bool* is_done); Result Y2RU_IsDoneReceiving(bool* is_done);
/// Sets the dithering weights /**
* @brief Configures the dithering weight parameters.
* @param params Dithering weight parameters to use.
*/
Result Y2RU_SetDitheringWeightParams(const Y2RU_DitheringWeightParams* params); Result Y2RU_SetDitheringWeightParams(const Y2RU_DitheringWeightParams* params);
/// Retrieves the dithering weights /**
* @brief Gets the configured dithering weight parameters.
* @param params Pointer to output the dithering weight parameters to.
*/
Result Y2RU_GetDitheringWeightParams(Y2RU_DitheringWeightParams* params); Result Y2RU_GetDitheringWeightParams(Y2RU_DitheringWeightParams* params);
/** /**
* @brief Sets all the parameters of Y2RU_ConversionParams at once. * @brief Sets all of the parameters of Y2RU_ConversionParams at once.
* @param params Conversion parameters to set.
* *
* Faster than calling the individual value through Y2R_Set* because only one system call is made. * Faster than calling the individual value through Y2R_Set* because only one system call is made.
*/ */
@ -418,21 +479,22 @@ Result Y2RU_StartConversion(void);
Result Y2RU_StopConversion(void); Result Y2RU_StopConversion(void);
/** /**
* @brief Check if the conversion and DMA transfer are finished * @brief Checks if the conversion and DMA transfer are finished.
* @param is_busy Pointer to output the busy state to.
* *
* This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt. * This can have the same problems as the event and interrupt. See @ref Y2RU_SetTransferEndInterrupt.
*/ */
Result Y2RU_IsBusyConversion(bool* is_busy); Result Y2RU_IsBusyConversion(bool* is_busy);
/** /**
* @brief Checks whether y2r is ready to be used. * @brief Checks whether Y2R is ready to be used.
* @param ping Pointer to output y2r's status to. * @param ping Pointer to output the ready status to.
*/ */
Result Y2RU_PingProcess(u8* ping); Result Y2RU_PingProcess(u8* ping);
/// Initializes the y2r driver. /// Initializes the Y2R driver.
Result Y2RU_DriverInitialize(void); Result Y2RU_DriverInitialize(void);
/// Terminates the y2r driver. /// Terminates the Y2R driver.
Result Y2RU_DriverFinalize(void); Result Y2RU_DriverFinalize(void);