Gazebo Rendering

API Reference

3.7.2
gz/rendering/PixelFormat.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef GZ_RENDERING_PIXELFORMAT_HH_
18 #define GZ_RENDERING_PIXELFORMAT_HH_
19 
20 #include <string>
21 #include "gz/rendering/config.hh"
22 #include "gz/rendering/Export.hh"
23 
24 namespace ignition
25 {
26  namespace rendering
27  {
28  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
29  //
32  enum IGNITION_RENDERING_VISIBLE PixelFormat
33  {
37  PF_L8 = 1,
39  PF_R8G8B8 = 2,
41  PF_B8G8R8 = 3,
50  // Float32 format one channel
52  // Float32 format and RGB
54  // Float32 format and RGB
56  // 16 bit single channel
57  PF_L16 = 11,
59  PF_COUNT = 12
60  };
61 
64  class IGNITION_RENDERING_VISIBLE PixelUtil
65  {
68  public: static bool IsValid(PixelFormat _format);
69 
75  public: static PixelFormat Sanitize(PixelFormat _format);
76 
80  public: static std::string Name(PixelFormat _format);
81 
86  public: static unsigned int ChannelCount(PixelFormat _format);
87 
92  public: static unsigned int BytesPerChannel(PixelFormat _format);
93 
98  public: static unsigned int BytesPerPixel(PixelFormat _format);
99 
108  public: static unsigned int MemorySize(PixelFormat _format,
109  unsigned int _width, unsigned int _height);
110 
116  public: static PixelFormat Enum(const std::string &_name);
117 
119  private: static const char *names[PF_COUNT];
120 
122  private: static const unsigned char channelCounts[PF_COUNT];
123 
125  private: static const unsigned char channelByteCounts[PF_COUNT];
126  };
127  }
128  }
129 }
130 #endif
Provides supporting functions for PixelFormat enum.
Definition: gz/rendering/PixelFormat.hh:64
@ PF_R8G8B8
< RGB, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:39
STL class.
PixelFormat
Image pixel format types.
Definition: gz/rendering/PixelFormat.hh:32
@ PF_BAYER_RGGB8
< Bayer RGGB, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:43
@ PF_FLOAT32_RGB
Definition: gz/rendering/PixelFormat.hh:55
static unsigned int MemorySize(PixelFormat _format, unsigned int _width, unsigned int _height)
Get total memory size in bytes for an image with the given format and dimensions. If an invalid forma...
@ PF_BAYER_GBGR8
< Bayer GBGR, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:47
static PixelFormat Enum(const std::string &_name)
Get enum value by human-readable name. The given string should match watch is returned by GetName....
@ PF_L8
< Grayscale, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:37
@ PF_FLOAT32_R
Definition: gz/rendering/PixelFormat.hh:51
static unsigned int BytesPerPixel(PixelFormat _format)
Get number of bytes per pixel for given format. If an invalid format is given, 0 will be returned....
static unsigned int BytesPerChannel(PixelFormat _format)
Get number of bytes per channel for given format. If an invalid format is given, 0 will be returned.
static unsigned int ChannelCount(PixelFormat _format)
Get number of channels for given format. If an invalid format is given, 0 will be returned.
@ PF_B8G8R8
< BGR, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:41
static std::string Name(PixelFormat _format)
Get human-readable name for pixel format value.
@ PF_BAYER_GRGB8
< Bayer GRGB, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:49
@ PF_L16
Definition: gz/rendering/PixelFormat.hh:57
static PixelFormat Sanitize(PixelFormat _format)
Sanitize given format. If the given value is invalid, PF_UNKNOWN will be returned,...
@ PF_FLOAT32_RGBA
Definition: gz/rendering/PixelFormat.hh:53
static bool IsValid(PixelFormat _format)
Determine if given format is valid PixelFormat enum.
@ PF_UNKNOWN
< Unknown or errant type
Definition: gz/rendering/PixelFormat.hh:35
@ PF_BAYER_BGGR8
< Bayer BGGR, 1-byte per channel
Definition: gz/rendering/PixelFormat.hh:45
@ PF_COUNT
< Number of pixel format types
Definition: gz/rendering/PixelFormat.hh:59