volume.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/blueprint/components/volume.def.rs".
 
#pragma once
 
#include "../../encodings/float32.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace rerun::blueprint::components {
    /// **Component**: Playback volume, as a multiplier applied to the audio samples.
    ///
    /// 0.0 is silent and 1.0 leaves the samples unchanged.
    /// The scale is linear in amplitude, not in perceived loudness.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct Volume {
        rerun::encodings::Float32 volume;
 
      public:
        Volume() = default;
 
        Volume(rerun::encodings::Float32 volume_) : volume(volume_) {}
 
        Volume& operator=(rerun::encodings::Float32 volume_) {
            volume = volume_;
            return *this;
        }
 
        Volume(float value_) : volume(value_) {}
 
        Volume& operator=(float value_) {
            volume = value_;
            return *this;
        }
 
        /// Cast to the underlying Float32 encoding
        operator rerun::encodings::Float32() const {
            return volume;
        }
    };
} // namespace rerun::blueprint::components
 
namespace rerun {
    static_assert(sizeof(rerun::encodings::Float32) == sizeof(blueprint::components::Volume));
 
    /// \private
    template <>
    struct Loggable<blueprint::components::Volume> {
        static constexpr std::string_view ComponentType = "rerun.blueprint.components.Volume";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
            return Loggable<rerun::encodings::Float32>::arrow_data_type();
        }
 
        /// Serializes an array of `rerun::blueprint:: components::Volume` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const blueprint::components::Volume* instances, size_t num_instances
        ) {
            if (num_instances == 0) {
                return Loggable<rerun::encodings::Float32>::to_arrow(nullptr, 0);
            } else if (instances == nullptr) {
                return rerun::Error(
                    ErrorCode::UnexpectedNullArgument,
                    "Passed array instances is null when num_elements> 0."
                );
            } else {
                return Loggable<rerun::encodings::Float32>::to_arrow(
                    &instances->volume,
                    num_instances
                );
            }
        }
    };
} // namespace rerun