declare_scratch()

ScalarRef MayaFlux::Buffers::VolumeGridBuffer::declare_scratch	(	std::string	name,
		Kinesis::LatticeSemantics	semantics = {}
	)

Declare a single-slot scalar field.

Parameters

name	Lookup key, unique within this volume.
semantics	What the values mean. A divergence field wants

Returns

Ref naming the field, or a ref with an empty name if the declaration was rejected.

Read and write resolve to one handle, which suits a quantity recomputed from other fields every cycle and never carried across cycles: divergence is the ordinary case. A stage that reads a neighbourhood of a field it also writes cannot use one of these, and VolumeFieldProcessor rejects that arrangement at attach.

Definition at line 177 of file VolumeGridBuffer.cpp.

{
    if (!allocate_field(name, sizeof(float), false, semantics)) {
        return {};
    }
 
    return ScalarRef {
        .name = std::move(name),
        .owner = std::dynamic_pointer_cast<VolumeGridBuffer>(shared_from_this()),
    };
}

References allocate_field(), MayaFlux::Buffers::ScalarRef::name, and name.

Here is the call graph for this function: