PixelFormat.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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 IGNITION_RENDERING_PIXELFORMAT_HH_
#define IGNITION_RENDERING_PIXELFORMAT_HH_

#include <string>
#include "ignition/rendering/config.hh"
#include "ignition/rendering/Export.hh"

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    enum IGNITION_RENDERING_VISIBLE PixelFormat
    {
      PF_UNKNOWN      = 0,
      PF_L8           = 1,
      PF_R8G8B8       = 2,
      PF_B8G8R8       = 3,
      PF_BAYER_RGGB8  = 4,
      PF_BAYER_BGGR8  = 5,
      PF_BAYER_GBGR8  = 6,
      PF_BAYER_GRGB8  = 7,
      // Float32 format one channel
      PF_FLOAT32_R    = 8,
      // Float32 format and RGB
      PF_FLOAT32_RGBA = 9,
      // Float32 format and RGB
      PF_FLOAT32_RGB  = 10,
      // 16 bit single channel
      PF_L16          = 11,
      PF_COUNT        = 12
    };

    class IGNITION_RENDERING_VISIBLE PixelUtil
    {
      public: static bool IsValid(PixelFormat _format);

      public: static PixelFormat Sanitize(PixelFormat _format);

      public: static std::string Name(PixelFormat _format);

      public: static unsigned int ChannelCount(PixelFormat _format);

      public: static unsigned int BytesPerChannel(PixelFormat _format);

      public: static unsigned int BytesPerPixel(PixelFormat _format);

      public: static unsigned int MemorySize(PixelFormat _format,
                  unsigned int _width, unsigned int _height);

      public: static PixelFormat Enum(const std::string &_name);

      private: static const char *names[PF_COUNT];

      private: static const unsigned char channelCounts[PF_COUNT];

      private: static const unsigned char channelByteCounts[PF_COUNT];
    };
    }
  }
}
#endif