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

Syntax

static nnResult ClearTexture2DResource(
     const Texture2DResource * tex2DResource,
     s32 mipLevelIndexStart,
     s32 mipLevelIndexEnd,
     const u8 Components[4]
);

Arguments

Name Description
in tex2DResource Specifies a pointer to the Texture2DResource resource 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 Components[4] Specifies the component whose resource is 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.
ResultInvalidTextureFormat A format other than ETC and depth formats included in Resource::NativeFormat have been specified for the format of the 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

Clears Texture2DResource resources using the color specified in the argument Components.

Revision History

2011/02/21
Initial version.

CONFIDENTIAL