nn::gd::CTR::Memory::ClearTargets Member Function

Syntax

static nnResult ClearTargets(
     const RenderTarget * renderTarget,
     const DepthStencilTarget * depthStencilTarget,
     const u8 ColorRGBA[4],
     float depth,
     u8 stencil
);

Arguments

Name Description
in renderTarget Specifies a pointer to the render target to be cleared.
in depthStencilTarget Specifies a pointer to the depth stencil target to be cleared.
in ColorRGBA[4] Specifies a color value for the RGB format used by the render target to be cleared.
in depth Specifies a depth value for the depth stencil target to be cleared.
in stencil Specifies a stencil value for the depth stencil target to be cleared.

Return Values

Returns the result of the operation.
Value Description
ResultSuccess Process was successful.
ResultInvalidTextureFormat Indicates that the pixel format of the specified render target or depth stencil target is invalid.

Description

Adds a command for clearing the specified target memory.

Pixel formats that can be specified for the render target:
NATIVE_FORMAT_RGBA_8888
NATIVE_FORMAT_GAS
NATIVE_FORMAT_SHADOW
NATIVE_FORMAT_RGBA_5551
NATIVE_FORMAT_RGB_565
NATIVE_FORMAT_RGBA_4444
.

Pixel formats that can be specified for the depth stencil target:
NATIVE_FORMAT_DEPTH_24_STENCIL_8
NATIVE_FORMAT_DEPTH_24
NATIVE_FORMAT_DEPTH_16
.

Revision History

2011/02/17
Initial version.

CONFIDENTIAL