Skip to content

Commit 47702b4

Browse files
Updated documentation for WebGPU backend interfaces
1 parent a02c097 commit 47702b4

File tree

5 files changed

+16
-9
lines changed

5 files changed

+16
-9
lines changed

Graphics/GraphicsEngineWebGPU/interface/BufferWebGPU.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023-2024 Diligent Graphics LLC
2+
* Copyright 2023-2025 Diligent Graphics LLC
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -49,6 +49,8 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_BufferWebGPU =
4949
/// Exposes WebGPU-specific functionality of a buffer object.
5050
DILIGENT_BEGIN_INTERFACE(IBufferWebGPU, IBuffer)
5151
{
52+
/// Returns WebGPU buffer handle.
53+
5254
/// The application must not destroy the returned buffer
5355
/// Returns a WebGPU handle of the internal buffer object.
5456
VIRTUAL WGPUBuffer METHOD(GetWebGPUBuffer)(THIS) CONST PURE;

Graphics/GraphicsEngineWebGPU/interface/PipelineStateWebGPU.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2024 Diligent Graphics LLC
2+
* Copyright 2024-2025 Diligent Graphics LLC
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -47,10 +47,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_PipelineStateWebGPU =
4747
/// Exposes WebGPU-specific functionality of a pipeline state object.
4848
DILIGENT_BEGIN_INTERFACE(IPipelineStateWebGPU, IPipelineState)
4949
{
50-
/// Returns a pointer to WebGPU render pipeline (WGPURenderPipeline)
50+
/// Returns a pointer to WebGPU render pipeline (`WGPURenderPipeline`)
5151
VIRTUAL WGPURenderPipeline METHOD(GetWebGPURenderPipeline)(THIS) CONST PURE;
5252

53-
/// Returns a pointer to WebGPU compute pipeline (WGPUComputePipeline)
53+
/// Returns a pointer to WebGPU compute pipeline (`WGPUComputePipeline`)
5454
VIRTUAL WGPUComputePipeline METHOD(GetWebGPUComputePipeline)(THIS) CONST PURE;
5555
};
5656
DILIGENT_END_INTERFACE

Graphics/GraphicsEngineWebGPU/interface/RenderDeviceWebGPU.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceWebGPU, IRenderDevice)
6767
/// texture interface will be stored.
6868
/// The function calls AddRef(), so that the new object will contain
6969
/// one reference.
70+
///
7071
/// \note Created texture object does not take ownership of the WebGPU texture and will not
7172
/// destroy it once released. The application must not destroy the image while it is
7273
/// in use by the engine.
@@ -87,6 +88,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceWebGPU, IRenderDevice)
8788
/// buffer interface will be stored.
8889
/// The function calls AddRef(), so that the new object will contain
8990
/// one reference.
91+
///
9092
/// \note Created buffer object does not take ownership of the WebGPU buffer and will not
9193
/// destroy it once released. The application must not destroy Vulkan buffer while it is
9294
/// in use by the engine.

Graphics/GraphicsEngineWebGPU/interface/ShaderWebGPU.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2024 Diligent Graphics LLC
2+
* Copyright 2024-2025 Diligent Graphics LLC
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -55,11 +55,13 @@ class IShaderWebGPU : public IShader
5555
/// Returns WGSL source code
5656
virtual const std::string& DILIGENT_CALL_TYPE GetWGSL() const = 0;
5757

58-
/// Returns a suffix to append to the name of emulated array variables to get
58+
/// Returns emulated array index suffix
59+
60+
/// Returns a suffix to append to the name of an emulated array variables to get
5961
/// the indexed array element name.
6062
///
61-
/// \remarks This value is defined by ShaderCI.WebGPUEmulatedArrayIndexSuffix,
62-
/// see Diligent::ShaderCreateInfo::WebGPUEmulatedArrayIndexSuffix.
63+
/// This value is defined by `ShaderCI.WebGPUEmulatedArrayIndexSuffix`,
64+
/// see Diligent::ShaderCreateInfo::WebGPUEmulatedArrayIndexSuffix.
6365
virtual const char* DILIGENT_CALL_TYPE GetEmulatedArrayIndexSuffix() const = 0;
6466
};
6567

Graphics/GraphicsEngineWebGPU/interface/TextureWebGPU.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023-2024 Diligent Graphics LLC
2+
* Copyright 2023-2025 Diligent Graphics LLC
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -50,6 +50,7 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_TextureWebGPU =
5050
DILIGENT_BEGIN_INTERFACE(ITextureWebGPU, ITexture)
5151
{
5252
/// Returns WebGPU texture handle.
53+
5354
/// The application must not destroy the returned texture
5455
VIRTUAL WGPUTexture METHOD(GetWebGPUTexture)(THIS) CONST PURE;
5556

0 commit comments

Comments
 (0)