gx2: Add GX2GetLastFrame, GX2GetLastFrameGamma documentation (#451)

* gx2: Add GX2GetLastFrame, GX2GetLastFrameGamma documentation

* GX2GetLastFrame: Adjust parameter wording
Implied image data was only being updated
This commit is contained in:
SuperZoruaFan
2026-08-01 13:59:54 -07:00
committed by GitHub
parent 6f9a38068d
commit ae318fcb33

View File

@@ -22,10 +22,34 @@ GX2CopyColorBufferToScanBuffer(const GX2ColorBuffer *buffer,
void
GX2SwapScanBuffers();
/**
* Gets the last frame displayed before exiting foreground.
* This can be used for transition effects with the splash.
*
* \param scanTarget
* The scan-target to source from.
*
* \param texture
* A pointer to store the texture of the last frame. The resulting surface format is #GX2_SURFACE_FORMAT_SRGB_R8_G8_B8_A8.
*
* \sa
* - GX2GetLastFrameGamma()
*/
BOOL
GX2GetLastFrame(GX2ScanTarget scanTarget,
GX2Texture *texture);
/**
* Gets the gamma of the last frame displayed before exiting foreground.
* \param scanTarget
* The scan-target to source from.
*
* \param gammaOut
* A pointer to store the gamma.
*
* \sa
* - GX2GetLastFrame()
*/
BOOL
GX2GetLastFrameGamma(GX2ScanTarget scanTarget,
float *gammaOut);