nn::gd::CTR::System::StopRecordingPackets Member Function

Syntax

static nnResult StopRecordingPackets(
     RecordedPacketId ** packetId
);

Parameters

Name Description
in packetId Sets the address storing the save start ID pointer of the obtained command list object.

Return Values

Returns the result of the operation.
Value Description
Result::IsSuccess The process was successful.
ResultNullParameter NULL was specified in packetId.
ResultSystemNoPacketRecorded Saving of command list objects has not started. Start saving them by calling the SystemStartRecordingPackets function.
ResultSystemInvalidCmdListBind The command list to start saving differs from the current command list.
ResultSystemReceiveErrorFromGlGetError The nngxStopCmdlistSave function or the nngxExportCmdlist function could not be executed correctly.
ResultSystemNoPacketToRecord There was no saved data.
ResultOutOfMemory Could not allocate memory.
ResultSystemRequestListInsertionIncompatibleWithJump (Only when RECORD_3D_COMMAND_BUFFER_FOR_JUMP is specified) Jump cannot be utilized because command requests other than 3D execution commands are included.
ResultInvalidParameter The parameter is invalid.

Description

Stops saving the current command list object.

Command packets for function calls between the System::StartRecordingPackets and System::StopRecordingPackets functions are stored so that they can be reused later. When RECORD_COMMAND_LIST_COPY or RECORD_3D_COMMAND_BUFFER_FOR_JUMP is specified as the RecordingPacketUsage parameter to the System::StartRecordingPackets function, command packets are stored in a user buffer. These command packets can be edited and executed when necessary. If RECORD_COMMAND_LIST_NO_COPY is specified as the RecordingPacketUsage parameter, the command packets saved in the GD function's internal command buffer can be reused directly, without being copied. In this case, these command packets cannot be edited before they are executed nor can they be reused after the command buffer is cleared.

Revision History

2011/02/17
Initial version.

CONFIDENTIAL