influx()

std::shared_ptr< InfluxProcessor > MayaFlux::Buffers::VolumeGridBuffer::influx	(	const std::string &	field,
		const InfluxProcessor::Spot &	spot,
		const std::string &	shader = "volume_influx_blob.comp.spv"
	)

Add an influx stage to this volume's chain and return it.

Parameters

field	Name of the double buffered field added into.
spot	Placement and strength.
shader	Shader defining shape(). The default is a soft round blob.

Returns

The stage, already in the chain, or nullptr if the volume is not registered yet. Retune it with its own setters.

Call after registration. A stage added before setup_flow runs ahead of the flow stages, which is where an influx belongs. One added after runs behind them, so what it adds is not transported until the next cycle.

Definition at line 299 of file VolumeGridBuffer.cpp.

{
    auto chain = get_processing_chain();
    if (!chain) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::Init,
            "influx: no processing chain, call after registration");
        return nullptr;
    }
 
    auto stage = std::make_shared<InfluxProcessor>(field, shader, spot);
    chain->add_processor(stage, std::dynamic_pointer_cast<VolumeGridBuffer>(shared_from_this()));
    return stage;
}

References MayaFlux::Journal::Buffers, chain, MayaFlux::Buffers::VKBuffer::get_processing_chain(), MayaFlux::Journal::Init, and MF_ERROR.

Here is the call graph for this function: