ramCanvas.hpp File Reference

User include file for ramCanvas types. More...

#include "MRcolor.hpp"
#include "ramCanvasTpl.hpp"

Include dependency graph for ramCanvas.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	mjr

Macros
#define	MJR_INCLUDE_ramCanvas

Simple Canvas Coordinate Types
typedef double	mjr::rcSimpleFltCrdT
	Real coordinate type.
typedef int	mjr::rcSimpleIntCrdT
	Integer coordinate type.

Simple Color Canvas Type (8 channels at 8 bits per channel)
typedef ramCanvasTpl< color8c8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas8c8b
	Canvas type: generic 64-bit with 8 channels at 8-bit uint per channel.

Simple Color Canvas Types (3 and 4 channels at 8 bits per channel)
typedef ramCanvasTpl< color4c8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c8b
	Canvas type: generic 32-bit with 4 channels at 8-bit uint per channel.
typedef ramCanvasTpl< color3c8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c8b
	Canvas type: generic 24-bit with 3 channels at 8-bit uint per channel.
typedef ramCanvas4c8b	mjr::ramCanvasRGBA8b
	Canvas type: 24-bit true color with alpha last (RGBA) – 4 channels at 8-bit uint per channel.
typedef ramCanvas3c8b	mjr::ramCanvasRGB8b
	Canvas type: 24-bit true color without alpha (RGB) – 3 channels at 8-bit uint per channel.

Simple Color Canvas Types (3 and 4 channels at 16 bits per channel)
typedef ramCanvasTpl< color4c16b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c16b
	Canvas type: Generic 64-bit with 4 channels at 16-bit uint per channel.
typedef ramCanvasTpl< color3c16b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c16b
	Canvas type: Generic 48-bit with 4 channels at 16-bit uint per channel.
typedef ramCanvas4c16b	mjr::ramCanvasRGBA16b
	Canvas type: 48-bit true color with alpha (RGBA) – 4 channels at 16-bit uint per channel.
typedef ramCanvas3c16b	mjr::ramCanvasRGB16b
	Canvas type: 48-bit true color without alpha (RGB) – 3 channels at 16-bit uint per channel.

Simple Color Canvas Types (3 and 4 channels at 32 bits per channel)
typedef ramCanvasTpl< color4c32b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c32b
	Canvas type: Generic 64-bit with 4 channels at 32-bit uint per channel.
typedef ramCanvasTpl< color3c32b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c32b
	Canvas type: Generic 48-bit with 4 channels at 32-bit uint per channel.
typedef ramCanvas4c32b	mjr::ramCanvasRGBA32b
	Canvas type: 48-bit true color with alpha (RGBA) – 4 channels at 32-bit uint per channel.
typedef ramCanvas3c32b	mjr::ramCanvasRGB32b
	Canvas type: 48-bit true color without alpha (RGB) – 3 channels at 32-bit uint per channel.

Simple Color Canvas Types (3 and 4 channels at 64 bits per channel)
typedef ramCanvasTpl< color4c64b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c64b
	Canvas type: Generic 64-bit with 4 channels at 64-bit uint per channel.
typedef ramCanvasTpl< color3c64b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c64b
	Canvas type: Generic 48-bit with 4 channels at 64-bit uint per channel.
typedef ramCanvas4c64b	mjr::ramCanvasRGBA64b
	Canvas type: 48-bit true color with alpha (RGBA) – 4 channels at 64-bit uint per channel.
typedef ramCanvas3c64b	mjr::ramCanvasRGB64b
	Canvas type: 48-bit true color without alpha (RGB) – 3 channels at 64-bit uint per channel.

Simple Monochrome Canvas Types (1 channel uint at various depths)
typedef ramCanvasTpl< color1c8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c8b
	Canvas type: 8-bit uint grey-scale – 1 channel, 8-bit.
typedef ramCanvasTpl< color1c16b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c16b
	Canvas type: 16-bit uint grey-scale – 1 channel, 16-bit.
typedef ramCanvasTpl< color1c32b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c32b
	Canvas type: 32-bit uint grey-scale – 1 channel, 32-bit.
typedef ramCanvasTpl< color1c64b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c64b
	Canvas type: 64-bit uint grey-scale – 1 channel, 64-bit.
typedef ramCanvasTpl< color1c32F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c32F
	Canvas type: 32-bit single float grey-scale – 1 channel, 32-bit.
typedef ramCanvasTpl< color1c64F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas1c64F
	Canvas type: 64-bit double float grey-scale – 1 channel, 64-bit.

Simple Color Canvas Types (3 and 4 channels with double float channels)
typedef ramCanvasTpl< color4c64F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c64F
	Canvas type: generic 4 channels with double float channels.
typedef ramCanvasTpl< color3c64F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c64F
	Canvas type: generic 3 channels with double float channels.
typedef ramCanvas4c64F	mjr::ramCanvasRGBA64F
	Canvas type: RGBA with double float channels.
typedef ramCanvas3c64F	mjr::ramCanvasRGB64F
	Canvas type: RGB with double float channels.

Simple Color Canvas Types (3 and 4 channels with single float channels)
typedef ramCanvasTpl< color4c32F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas4c32F
	Canvas type: generic 4 channels with single float channels.
typedef ramCanvasTpl< color3c32F, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvas3c32F
	Canvas type: generic 3 channels with single float channels.
typedef ramCanvas4c32F	mjr::ramCanvasRGBA32F
	Canvas type: RGBA with single float channels.
typedef ramCanvas3c32F	mjr::ramCanvasRGB32F
	Canvas type: RGB with single float channels.

Simple Color Canvas Types with 8-bit channels and commonly used orderings for R, G, B, & A.
These are commonly used by libraries like Cairo, Open GL, SDL, etc...
typedef ramCanvasTpl< colorBGR8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvasBGR8b
	colorTpl: 3 Channel @ 8-bit unsigned int channels BGR8b
typedef ramCanvasTpl< colorARGB8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvasARGB8b
	colorTpl: 4 Channel @ 8-bit unsigned int channels ARGB8b
typedef ramCanvasTpl< colorBGRA8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvasBGRA8b
	colorTpl: 4 Channel @ 8-bit unsigned int channels BGRA8b
typedef ramCanvasTpl< colorABGR8b, rcSimpleIntCrdT, rcSimpleFltCrdT, false >	mjr::ramCanvasABGR8b
	colorTpl: 4 Channel @ 8-bit unsigned int channels ABGR8b

Detailed Description

User include file for ramCanvas types.

Author

Mitch Richling https://www.mitchr.me

Copyright

Copyright (c) 1988-2015, Mitchell Jay Richling https://www.mitchr.me All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file ramCanvas.hpp.

Macro Definition Documentation

MJR_INCLUDE_ramCanvas

#define MJR_INCLUDE_ramCanvas

Definition at line 124 of file ramCanvas.hpp.