Browse Source

doc: document the need for & / && CreateInfo setter overloads.

pull/491/head
Vladimír Vondruš 5 years ago
parent
commit
9aeefce801
  1. 8
      doc/developers.dox

8
doc/developers.dox

@ -810,6 +810,14 @@ unless it doesn't affect public API at all.
handles), it should be made move-only with the `other._info` members handles), it should be made move-only with the `other._info` members
pointing to the stolen state cleared so the old instance doesn't reference pointing to the stolen state cleared so the old instance doesn't reference
state that's owned by something else after the move. state that's owned by something else after the move.
- Additionally, if a move-only class needs to be itself moved into a
containing structure (such as @ref Vk::SubpassDescription inside a
@ref Vk::RenderPassCreateInfo), all its setters should have @cpp & @ce
and @cpp && @ce overloads so it can be set up completely and passed to
its destination in a single expression without any explicit
@cpp std::move() @ce. The overloads can be tested for correctness
rather easily, see `RenderPassTest::subpassDescriptionRvalue()` for an
example.
@section developers-vk-extension-dependent Checklist for Vulkan extension-dependent code paths @section developers-vk-extension-dependent Checklist for Vulkan extension-dependent code paths

Loading…
Cancel
Save