A scalar field's name, issued by the volume that owns it. More...
#include <VolumeGridBuffer.hpp>
Collaboration diagram for MayaFlux::Buffers::ScalarRef:Public Member Functions | |
| bool | issued_by (const VolumeGridBuffer *volume) const |
| Whether this ref was issued by the given volume. | |
| operator const std::string & () const | |
Public Attributes | |
| std::string | name |
| std::weak_ptr< VolumeGridBuffer > | owner |
Static Public Attributes | |
| static constexpr size_t | stride = sizeof(float) |
Detailed Description
A scalar field's name, issued by the volume that owns it.
Exists so a field is spelled once, at declaration, rather than at every site that addresses it. A name typed twice is two independent literals that must agree; a mismatch surfaces as a stage that runs and does nothing, which is the hardest failure in this subsystem to diagnose.
Converts implicitly to the field name, so a ref passes anywhere a processor expects a string. The type distinction bites where a signature demands one kind: a parameter taking ScalarRef cannot be handed a vector field.
Carries a weak reference to its issuer so a ref from one volume used against another can be rejected rather than silently resolving to a same-named field.
Definition at line 40 of file VolumeGridBuffer.hpp.
The documentation for this struct was generated from the following file:
