UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ClearQuad.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "Math/Color.h"
6#include "Math/IntPoint.h"
7#include "Math/IntRect.h"
9#include "Math/Vector4.h"
10#include "RenderResource.h"
11#include "Templates/Function.h"
12
14class FRHICommandList;
16struct FRWBuffer;
18
20{
21public:
25 virtual void InitRHI(FRHICommandListBase& RHICmdList) override;
26};
28
35
37extern RENDERCORE_API void DrawClearQuadAlpha(FRHICommandList& RHICmdList, float Alpha);
38extern RENDERCORE_API void DrawClearQuadMRT(FRHICommandList& RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor* ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil);
39extern RENDERCORE_API void DrawClearQuadMRT(FRHICommandList& RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor* ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil, FClearQuadCallbacks ClearQuadCallbacks);
40extern RENDERCORE_API void DrawClearQuadMRT(FRHICommandList& RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor* ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil, FIntPoint ViewSize, FIntRect ExcludeRect);
41extern RENDERCORE_API void DrawClearQuadMRTWithUints(FRHICommandList& RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor* ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil, uint8 NumUintOutput);
42
43inline void DrawClearQuad(FRHICommandList& RHICmdList, bool bClearColor, const FLinearColor& Color, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil)
44{
45 DrawClearQuadMRT(RHICmdList, bClearColor, 1, &Color, bClearDepth, Depth, bClearStencil, Stencil);
46}
47
48inline void DrawClearQuad(FRHICommandList& RHICmdList, bool bClearColor, const FLinearColor& Color, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil, FIntPoint ViewSize, FIntRect ExcludeRect)
49{
50 DrawClearQuadMRT(RHICmdList, bClearColor, 1, &Color, bClearDepth, Depth, bClearStencil, Stencil, ViewSize, ExcludeRect);
51}
52
53inline void DrawClearQuad(FRHICommandList& RHICmdList, const FLinearColor& Color)
54{
55 DrawClearQuadMRT(RHICmdList, true, 1, &Color, false, 0, false, 0);
56}
57
59{
60 DrawClearQuadMRT(RHICmdList, true, 1, &Color, false, 0, false, 0, ClearQuadCallbacks);
61}
62
63
64#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
65#include "CoreMinimal.h"
66#include "RHI.h"
67#include "RHICommandList.h"
68#include "RHIDefinitions.h"
69#include "RendererInterface.h"
70#endif
OODEFFUNC typedef void(OODLE_CALLBACK t_fp_OodleCore_Plugin_Free)(void *ptr)
RENDERCORE_API TGlobalResource< FClearVertexBuffer > GClearVertexBuffer
Definition ClearQuad.cpp:27
RENDERCORE_API void DrawClearQuadAlpha(FRHICommandList &RHICmdList, float Alpha)
Definition ClearQuad.cpp:104
RENDERCORE_API void DrawClearQuadMRTWithUints(FRHICommandList &RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor *ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil, uint8 NumUintOutput)
Definition ClearQuad.cpp:128
RENDERCORE_API void ClearUAV(FRHICommandList &RHICmdList, FRHIUnorderedAccessView *Buffer, uint32 NumBytes, uint32 Value, bool bBarriers=true)
void DrawClearQuad(FRHICommandList &RHICmdList, bool bClearColor, const FLinearColor &Color, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil)
Definition ClearQuad.h:43
RENDERCORE_API void DrawClearQuadMRT(FRHICommandList &RHICmdList, bool bClearColor, int32 NumClearColors, const FLinearColor *ClearColorArray, bool bClearDepth, float Depth, bool bClearStencil, uint32 Stencil)
Definition ClearQuad.cpp:113
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
uint8_t uint8
Definition binka_ue_file_header.h:8
uint32_t uint32
Definition binka_ue_file_header.h:6
Definition ClearQuad.h:20
virtual void InitRHI(FRHICommandListBase &RHICmdList) override
Definition ClearQuad.cpp:21
Definition RHIResources.h:4572
Definition RHICommandList.h:455
Definition RHICommandList.h:3819
Definition RHIResources.h:3294
Definition RenderResource.h:474
Definition AndroidPlatformMisc.h:14
Definition RenderResource.h:543
Definition ClearQuad.h:30
TFunction< void(FGraphicsPipelineStateInitializer &)> PSOModifier
Definition ClearQuad.h:31
TFunction< void(FRHICommandList &)> PreClear
Definition ClearQuad.h:32
TFunction< void(FRHICommandList &)> PostClear
Definition ClearQuad.h:33
Definition Color.h:48
Definition RHIUtilities.h:423
Definition RHIUtilities.h:181
Definition IntPoint.h:25