Skip to content

Commit 5e25e2d

Browse files
bghgaryCopilot
andcommitted
Drop bgfx mention from UpdateDevice doc-comment
bgfx is an implementation detail not part of the public Device API surface; the doc-comment should describe behavior in terms of the public API (EnableRendering / DisableRendering / etc). [Created by Copilot on behalf of @bghgary] Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c257157 commit 5e25e2d

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

  • Core/Graphics/Include/Shared/Babylon/Graphics

Core/Graphics/Include/Shared/Babylon/Graphics/Device.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,13 @@ namespace Babylon::Graphics
113113

114114
void UpdateWindow(WindowT window);
115115

116-
// Sets the underlying graphics device that bgfx is initialized with on the next
117-
// EnableRendering call.
116+
// Sets the underlying graphics device used for rendering. The new device takes effect on
117+
// the next EnableRendering call.
118118
//
119-
// This API is only valid when rendering is disabled. Calling it while rendering is
120-
// enabled throws std::runtime_error: bgfx is already initialized with the previous device
121-
// and the swap would otherwise be silently buffered until the caller happens to do a
122-
// DisableRendering / EnableRendering cycle, leading to bugs that are hard to diagnose.
119+
// This API is only valid when rendering is disabled. Calling it while rendering is enabled
120+
// throws std::runtime_error: the swap would otherwise be silently buffered until the caller
121+
// happens to do a DisableRendering / EnableRendering cycle, leading to bugs that are hard
122+
// to diagnose.
123123
//
124124
// The typical call sequence to swap to a new device (e.g. on D3D11 / D3D12 device-removed
125125
// recovery) is:

0 commit comments

Comments
 (0)