A structure stores format information about image. More...

#include <full_image.hpp>

Public Member Functions
uint32_t	size () const noexcept

	image_format ()=default
	Construct a new image format object with default values.

	image_format (uint32_t width, uint32_t height, camera_orientation orientation, bool require_mirroring, int face_orientation, std::optional< float > fov=std::nullopt)
	Construct a new image format object with user's params.

Public Attributes
uint32_t	width = 0
	It is a width of image in pixels.

uint32_t	height = 0
	It is a height of image in pixels.

std::optional< float >	fov = std::nullopt
	It is a field of view in degrees.

camera_orientation	orientation = camera_orientation::deg_270
	It is a camera orientation in degrees as enum value (.

bool	require_mirroring = false
	This value is responsible for mirroring image during rendering.

int	face_orientation = 0
	It is a face orientation in degrees.

Detailed Description

A structure stores format information about image.

Definition at line 85 of file full_image.hpp.

Constructor & Destructor Documentation

◆ image_format()

bnb::image_format::image_format	(	uint32_t	width,
		uint32_t	height,
		camera_orientation	orientation,
		bool	require_mirroring,
		int	face_orientation,
		std::optional< float >	fov = std::nullopt )

Construct a new image format object with user's params.

Parameters

width	is a width of image in pixels.
height	is a height of image in pixels.
orientation	is a camera orientation in degrees as enum value (

See also: camera_orientation).

Parameters

require_mirroring	is a variable responsible for mirroring image during rendering, i.e. if it is true the image will mirror during rendering and won't in another way.
face_orientation	is a face orientation in degrees.
fov	is a field of view in degrees.

Member Function Documentation

◆ size()

uint32_t bnb::image_format::size ( ) const

noexcept

Returns: Returns the image size in pixels, i.e. width * height.

Member Data Documentation

◆ face_orientation

int bnb::image_format::face_orientation = 0

It is a face orientation in degrees.

Definition at line 100 of file full_image.hpp.

◆ fov

std::optional<float> bnb::image_format::fov = std::nullopt

It is a field of view in degrees.

Definition at line 92 of file full_image.hpp.

◆ height

uint32_t bnb::image_format::height = 0

It is a height of image in pixels.

Definition at line 90 of file full_image.hpp.

◆ orientation

camera_orientation bnb::image_format::orientation = camera_orientation::deg_270

It is a camera orientation in degrees as enum value (.

See also: camera_orientation).

Definition at line 95 of file full_image.hpp.

◆ require_mirroring

bool bnb::image_format::require_mirroring = false

This value is responsible for mirroring image during rendering.

Definition at line 98 of file full_image.hpp.

◆ width

uint32_t bnb::image_format::width = 0

It is a width of image in pixels.

Definition at line 88 of file full_image.hpp.

The documentation for this struct was generated from the following file:

/Users/itumashyk/Workspace/banuba_sdk/libs/types/bnb/types/full_image.hpp

Public Member Functions

Public Attributes