IRHIComputeContext::RHIClearUAVUint

Clears a UAV to the multi-component unsigned integer value provided.

Windows
MacOS
Linux

Override Hierarchy

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/RHIContext.h

Include

#include "RHIContext.h"

Syntax

void RHIClearUAVUint
(
    FRHIUnorderedAccessView * UnorderedAccessViewRHI,
    const FUintVector4 & Values
)

Remarks

Clears a UAV to the multi-component unsigned integer value provided. Should only be called on UAVs with an integer format, or on structured buffers. Structured buffers are treated as a regular R32_UINT buffer during the clear operation, and the Values.X component is copied directly into the buffer without any format conversion. (Y,Z,W) of Values is ignored. Typed integer buffers undergo standard format conversion during the write operation. The conversion is determined by the format of the UAV.

Parameters

Parameter

Description

UnorderedAccessViewRHI

The UAV to clear.

Values

The values to clear the UAV to, one component per channel (XYZW = RGBA). Channels not supported by the UAV are ignored.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss