gz/rendering/PixelBuffer.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_RENDERING_PIXELBUFFER_HH_
#define GZ_RENDERING_PIXELBUFFER_HH_
 
#include <cstddef>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/Export.hh"
#include "gz/rendering/PixelFormat.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    class Image;
 
    class IGNITION_RENDERING_VISIBLE PixelBuffer
    {
      public: PixelBuffer(unsigned int _width, unsigned int _height,
                  PixelFormat _format, void *_data, std::size_t _size);
 
      public: explicit PixelBuffer(Image &_image);
 
      public: PixelBuffer(const PixelBuffer &_other) = default;
 
      public: PixelBuffer &operator=(const PixelBuffer &) = delete;
 
      public: PixelBuffer &operator=(PixelBuffer &&) = delete;
 
      public: ~PixelBuffer() = default;
 
      public: unsigned int Width() const;
 
      public: unsigned int Height() const;
 
      public: PixelFormat Format() const;
 
      public: std::size_t Size() const;
 
      public: std::size_t MemorySize() const;
 
      public: bool Valid() const;
 
      public: unsigned char *Data() const;
 
      private: const unsigned int width;
 
      private: const unsigned int height;
 
      private: const PixelFormat format;
 
      private: unsigned char *const data;
 
      private: const std::size_t size;
    };
    }
  }
}
#endif