SurfaceFormat

Description

Stores information about dimensions, depth image pixel format, coordinate offsets and scales of a surface.

Structure fields and default values (if defined) are described below:

  • int Width - Surface width
  • int Height - Surface height
  • PlainType Type = Int16 - Type of depth image pixel
  • Double XOffset - Surface offset in X axis
  • double XScale - Surface scale in X axis
  • Double YOffset - Surface offset in Y axis
  • double YScale - Surface scale in Y axis
  • Double ZOffset - Surface offset in Z axis
  • double ZScale - Surface scale in Z axis
struct SurfaceFormat
{
	int			Width;
	int			Height;
	PlainType	Type;
	Double		XOffset;
	double		XScale;
	Double		YOffset;
	double		YScale;
	Double		ZOffset;
	double		ZScale;

	explicit SurfaceFormat
	(
		PlainType Type_ = Int16 
	) :
		 Type(Type_) 
	{}

	int Width() const		{ return Width;		};
	int Height() const		{ return Height;	};
	PlainType Type() const	{ return Type;		};
	Double XOffset() const	{ return XOffset;	};
	double XScale() const	{ return XScale;	};
	Double YOffset() const	{ return YOffset;	};
	double YScale() const	{ return YScale;	};
	Double ZOffset() const	{ return ZOffset;	};
	double ZScale() const	{ return ZScale;	};

	bool operator == ( const avl::SurfaceFormat& rhs ) const
	{
		return Width == rhs.Width && 
			Height == rhs.Height && 
			Type == rhs.Type && 
			XOffset == rhs.XOffset && 
			XScale == rhs.XScale && 
			YOffset == rhs.YOffset && 
			YScale == rhs.YScale && 
			ZOffset == rhs.ZOffset && 
			ZScale == rhs.ZScale;
	}

	bool operator != ( const avl::SurfaceFormat& rhs ) const
	{
		return !(operator==(rhs));
	}

};