MayaFlux 0.5.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::IO::VolumeWriter Class Referenceabstract

Abstract base for volumetric format writers. More...

#include <VolumeWriter.hpp>

+ Inheritance diagram for MayaFlux::IO::VolumeWriter:
+ Collaboration diagram for MayaFlux::IO::VolumeWriter:

Public Member Functions

virtual bool can_write (const std::string &filepath) const =0
 Check whether this writer handles the given filepath.
 
virtual std::string get_last_error () const =0
 Last error message or empty string.
 
virtual std::vector< std::string > get_supported_extensions () const =0
 File extensions handled by this writer (without dot).
 
virtual bool write (const std::string &filepath, const Kakshya::VolumeData &data, const VolumeWriteOptions &options={})=0
 Write volume data to disk.
 
virtual ~VolumeWriter ()=default
 

Detailed Description

Abstract base for volumetric format writers.

Parallels ImageWriter. Each concrete writer handles one or more file extensions and is responsible for validating that the supplied VolumeData is something its format can express: a format with no vector grid type rejects a vector field rather than silently dropping a component.

Writers are single-shot: one call to write() produces one file. A frame sequence is a sequence of calls with different paths, since no volumetric format in common use carries time within a single file.

A writer receives host memory and nothing else. No Vulkan, no buffer, no knowledge of what produced the values.

Definition at line 80 of file VolumeWriter.hpp.


The documentation for this class was generated from the following file: