nngxTransferRenderImage Function

Syntax

NNGX_APICALL void NNGX_APIENTRY nngxTransferRenderImage(
     GLuint buffer,
     GLenum mode,
     GLboolean yflip,
     GLint colorx,
     GLint colory
);

Arguments

Name Description
in buffer Display buffer to transfer to
in mode Antialias mode
in yflip Enables or disables flipping in the y direction
in colorx X coordinate from which to start transferring the color buffer
in colory Y coordinate from which to start transferring the color buffer

Return Values

No values are returned.

Description

Transfers images from the current color buffer to the display buffer specified by buffer.

A partial rectangle with the coordinates (colorx, colory) at the lower-left corner is transferred from the color buffer to the display buffer. The distance from colorx to the right, and from colory to the top, of the color buffer being transferred must be at least the size of the width and height, respectively, of the display buffer being transferred to.

You can perform anti-aliasing during the transfer. Set mode to one of the following values for the anti-aliasing mode.

NN_GX_ANTIALIASE_NOT_USEDNo anti-aliasing
NN_GX_ANTIALIASE_2x12x1 anti-aliasing
NN_GX_ANTIALIASE_2x22x2 anti-aliasing

With 2x1 anti-aliasing, the color buffer's partial rectangle must be at least twice as wide as the display buffer it is being transferred to. With 2x2 anti-aliasing, the color buffer's partial rectangle must be at least twice as wide and twice as tall as the display buffer it is being transferred to.

Set yflip to GL_TRUE to flip data in the y direction during the transfer. If you set yflip to GL_FALSE, data is not flipped in the y direction.

Set colorx and colory to a value greater than or equal to 0. You must set colorx and colory to a multiple of the block size. The block size is set by glRenderBlockModeDMP.

This function generates the following errors.

GL_ERROR_8027_DMP0 is bound to the current command list.
GL_ERROR_8028_DMPAn overflow occurred in the current command request.
GL_ERROR_8029_DMPEither an invalid value was specified for buffer, or no memory was allocated for the display buffer.
GL_ERROR_802A_DMPEither the destination color buffer was not set correctly (the render buffer is not attached), or no memory has been allocated for the render buffer.
GL_ERROR_802B_DMPThe mode argument was set to an invalid value.
GL_ERROR_802C_DMPEither the width of the transfer region of the color buffer (ColorBufferWidthInPixels - colorx) is smaller than the width of the display buffer, or the height of the transfer region of the color buffer (ColorBufferHeightInPixels - colory) is smaller than the height of the display buffer.
GL_ERROR_802D_DMPThe colorx or colory argument was set to an invalid value.
GL_ERROR_802E_DMPThe dimensions (in pixels) of the destination display buffer were larger than those of the source color buffer from which the data was supposed to be transferred.
GL_ERROR_802F_DMPA split command could not be added because the command buffer is full.

Revision History

2010/03/12
Added extended error code(s).
2010/01/07
Initial version.

CONFIDENTIAL