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

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

	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.

Returns the result of the operation.

Value	Description
Result::IsSuccess	The 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.

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

If the pixel format of the Texture2DResource to be cleared is smaller than 32 bits, 32-bit data is created for the specified value by repeating the number of times given by the resource pixel format size. FCRAM memory cannot be cleared. A function with the same functionality as nngxAddMemoryFillCommand is called internally. This function adds commands to the command list. For more information, see the programming manual.

2011/02/21

Initial version.