C++ Java Unity
C++ Reference
VideoBackgroundConfig Struct Reference

Detailed Description

Defines how the video background should be rendered.

Public Member Functions

 VideoBackgroundConfig ()
 Constructor to provide basic initialization. More...
 

Public Attributes

Vec2I mPosition
 Relative position of the video background in the render target, in pixels. More...
 
Vec2I mSize
 Width and height of the video background in pixels. More...
 

Constructor & Destructor Documentation

Constructor to provide basic initialization.

Member Data Documentation

Vec2I mPosition

Relative position of the video background in the render target, in pixels.

Describes the offset of the center of video background to the center of the screen (viewport) in pixels. A value of (0,0) centers the video background, whereas a value of (-10,15) moves the video background 10 pixels to the left and 15 pixels upwards.

Vec2I mSize

Width and height of the video background in pixels.

Using the device's screen size for this parameter scales the image to fullscreen. Notice that if the camera's aspect ratio is different than the screen's aspect ratio this will create a non-uniform stretched image.