nn::gd::CTR::Memory::ClearTexture2DResource Member Function

Syntax

static nnResult ClearTexture2DResource(
     const Texture2DResource * tex2DResource,
     s32 mipLevelIndexStart,
     s32 mipLevelIndexEnd,
     u32 value
);

Arguments

Name Description
in tex2DResource Specifies a pointer to the Texture2DResource to be cleared. Only a VRAM resource can be specified.
in mipLevelIndexStart Specifies the index of the first mipmap level to be cleared. (If -1 is specified, the last mipmap level index is used.)
in mipLevelIndexEnd Specifies the index of the last mipmap level to be cleared. (If -1 is specified, the last mipmap level index is used.)
in value Specifies the color value to be cleared.

Return Values

Returns the result of the operation.
Value Description
Result::IsSuccess Process was successful.
ResultNullParameter NULL was specified for the specified resource.
ResultInvalidTextureMipLevelIndex A value larger than mipLevelIndexEnd has been specified for mipLevelIndexStart. Or, a value larger than the mipmap level of the specified tex2DResource has been specified for mipLevelIndexEnd.
ResultInvalidMemoryRegion The resource memory type is invalid. The specified resource is in FCRAM region memory.

Description

Adds a command for clearing Texture2DResource using the specified value to the current command list.

Revision History

2011/02/21
Initial version.

CONFIDENTIAL