mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-07-25 00:41:40 +00:00
206 lines
8.3 KiB
C++
206 lines
8.3 KiB
C++
/******************************************************************************
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2023-2026 Baldur Karlsson
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
******************************************************************************/
|
|
|
|
#include "d3d12_test.h"
|
|
|
|
RD_TEST(D3D12_Annotations, D3D12GraphicsTest)
|
|
{
|
|
static constexpr const char *Description = "Test annotations via the D3D12 API.";
|
|
|
|
int main()
|
|
{
|
|
// initialise, create window, create device, etc
|
|
if(!Init())
|
|
return 3;
|
|
|
|
ID3D12ResourcePtr img = MakeTexture(DXGI_FORMAT_R32G32B32A32_FLOAT, 4, 4)
|
|
.RTV()
|
|
.InitialState(D3D12_RESOURCE_STATE_RENDER_TARGET);
|
|
|
|
img->SetName(L"Annotated Image");
|
|
DefaultTriVB->SetName(L"Vertex Buffer");
|
|
|
|
// cache the device pointer we pass in
|
|
void *d = dev;
|
|
|
|
if(rdoc)
|
|
{
|
|
rdoc->SetObjectAnnotation(d, img, "basic.bool", eRENDERDOC_Bool, 0, RDAnnotationHelper(true));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.int32", eRENDERDOC_Int32, 0, RDAnnotationHelper(-3));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.int64", eRENDERDOC_Int64, 0,
|
|
RDAnnotationHelper(-3000000000000LL));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.uint32", eRENDERDOC_UInt32, 0, RDAnnotationHelper(3));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.uint64", eRENDERDOC_UInt64, 0,
|
|
RDAnnotationHelper(3000000000000LL));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.float", eRENDERDOC_Float, 0,
|
|
RDAnnotationHelper(3.25f));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.double", eRENDERDOC_Double, 0,
|
|
RDAnnotationHelper(3.25000000001));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.string", eRENDERDOC_String, 0,
|
|
RDAnnotationHelper("Hello, World!"));
|
|
|
|
RENDERDOC_AnnotationValue val;
|
|
val.apiObject = (void *)DefaultTriVB;
|
|
rdoc->SetObjectAnnotation(d, img, "basic.object", eRENDERDOC_APIObject, 0, &val);
|
|
|
|
rdoc->SetObjectAnnotation(d, img, "basic.object.__offset", eRENDERDOC_UInt32, 0,
|
|
RDAnnotationHelper(64));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.object.__size", eRENDERDOC_UInt32, 0,
|
|
RDAnnotationHelper(32));
|
|
rdoc->SetObjectAnnotation(d, img, "basic.object.__rd_format", eRENDERDOC_String, 0,
|
|
RDAnnotationHelper("float4 vertex_data;"));
|
|
|
|
rdoc->SetObjectAnnotation(d, DefaultTriVB, "__rd_format", eRENDERDOC_String, 0,
|
|
RDAnnotationHelper("float3 pos;\n"
|
|
"float4 col;\n"
|
|
"float2 uv;\n"));
|
|
|
|
val = {};
|
|
val.vector.float32[0] = 1.1f;
|
|
val.vector.float32[1] = 2.2f;
|
|
val.vector.float32[2] = 3.3f;
|
|
val.vector.float32[3] = 4.4f; // should be ignored
|
|
rdoc->SetObjectAnnotation(d, img, "basic.vec3", eRENDERDOC_Float, 3, &val);
|
|
|
|
rdoc->SetObjectAnnotation(d, img, "deep.nested.path.to.annotation", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-4));
|
|
rdoc->SetObjectAnnotation(d, img, "deep.nested.path.to.annotation2", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-5));
|
|
rdoc->SetObjectAnnotation(d, img, "deep.alternate.path.to.annotation", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-6));
|
|
|
|
// deleted paths should not stay around
|
|
rdoc->SetObjectAnnotation(d, img, "deleteme", eRENDERDOC_Int32, 0, RDAnnotationHelper(-7));
|
|
rdoc->SetObjectAnnotation(d, img, "deleteme", eRENDERDOC_Empty, 0, NULL);
|
|
|
|
rdoc->SetObjectAnnotation(d, img, "path.deleted.by.parent", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-8));
|
|
rdoc->SetObjectAnnotation(d, img, "path.deleted.by.parent2", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-9));
|
|
|
|
// this will delete all children. `path` will still exist, but will be empty
|
|
rdoc->SetObjectAnnotation(d, img, "path.deleted", eRENDERDOC_Empty, 0, NULL);
|
|
}
|
|
|
|
while(Running())
|
|
{
|
|
if(rdoc)
|
|
{
|
|
// queue annotations are only included when in the captured frame
|
|
if(curFrame == 2)
|
|
rdoc->SetCommandAnnotation(d, queue, "queue.too_old", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(1000));
|
|
|
|
rdoc->SetCommandAnnotation(d, queue, "queue.value", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(1000));
|
|
|
|
rdoc->SetCommandAnnotation(d, queue, "command.overwritten", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(9999));
|
|
|
|
rdoc->SetCommandAnnotation(d, queue, "command.inherited", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(1234));
|
|
|
|
rdoc->SetCommandAnnotation(d, queue, "command.deleted", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(50));
|
|
}
|
|
|
|
ID3D12GraphicsCommandListPtr cmd = GetCommandBuffer();
|
|
|
|
Reset(cmd);
|
|
|
|
setMarker(cmd, "Start");
|
|
|
|
if(rdoc)
|
|
{
|
|
rdoc->SetCommandAnnotation(d, cmd, "new.value", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(2000));
|
|
|
|
rdoc->SetCommandAnnotation(d, cmd, "command.overwritten", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(-3333));
|
|
|
|
rdoc->SetCommandAnnotation(d, cmd, "command.new", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(3333));
|
|
|
|
rdoc->SetCommandAnnotation(d, cmd, "command.deleted", eRENDERDOC_Empty, 0, NULL);
|
|
}
|
|
|
|
setMarker(cmd, "Initial");
|
|
|
|
D3D12_CPU_DESCRIPTOR_HANDLE rtv =
|
|
MakeRTV(img).Format(DXGI_FORMAT_R32G32B32A32_FLOAT).CreateCPU(0);
|
|
|
|
ClearRenderTargetView(cmd, rtv, {0.2f, 0.2f, 0.2f, 1.0f});
|
|
|
|
ID3D12ResourcePtr bb = StartUsingBackbuffer(cmd, D3D12_RESOURCE_STATE_RENDER_TARGET);
|
|
|
|
ClearRenderTargetView(cmd, BBRTV, {0.2f, 0.2f, 0.2f, 1.0f});
|
|
|
|
if(rdoc)
|
|
rdoc->SetCommandAnnotation(d, cmd, "command.new", eRENDERDOC_Float, 0,
|
|
RDAnnotationHelper(1.75f));
|
|
|
|
cmd->IASetPrimitiveTopology(D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
|
|
|
|
IASetVertexBuffer(cmd, DefaultTriVB, sizeof(DefaultA2V), 0);
|
|
cmd->SetPipelineState(DefaultTriPSO);
|
|
cmd->SetGraphicsRootSignature(DefaultTriSig);
|
|
|
|
SetMainWindowViewScissor(cmd);
|
|
|
|
OMSetRenderTargets(cmd, {BBRTV}, {});
|
|
|
|
setMarker(cmd, "Pre-Draw");
|
|
|
|
// deleting a value is fine if it's re-added before the next event
|
|
if(rdoc)
|
|
{
|
|
rdoc->SetCommandAnnotation(d, cmd, "new.value", eRENDERDOC_Empty, 0, NULL);
|
|
rdoc->SetCommandAnnotation(d, cmd, "new.value", eRENDERDOC_Int32, 0,
|
|
RDAnnotationHelper(4000));
|
|
}
|
|
|
|
setMarker(cmd, "Draw 1");
|
|
|
|
cmd->DrawInstanced(3, 1, 0, 0);
|
|
|
|
RSSetViewport(
|
|
cmd, {0.0f, 0.0f, (float)screenWidth / 2.0f, (float)screenHeight / 2.0f, 0.0f, 1.0f});
|
|
|
|
setMarker(cmd, "Draw 2");
|
|
|
|
cmd->DrawInstanced(3, 1, 0, 0);
|
|
|
|
FinishUsingBackbuffer(cmd, D3D12_RESOURCE_STATE_RENDER_TARGET);
|
|
|
|
cmd->Close();
|
|
|
|
SubmitAndPresent({cmd});
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
REGISTER_TEST();
|