Final Platform Layer  0.9.6-beta
Data Structures | Typedefs | Functions
Video functions

This category contains functions for retrieving or resizing the video buffer. More...

Data Structures

struct  fplVideoBackBuffer
 A structure containing video backbuffer properties. More...
 
struct  fplVideoRect
 A structure defining a video rectangles position and size. More...
 
union  fplVideoRequirements
 Stores the video requirements for the desired video backend. More...
 
struct  fplVideoRequirementsVulkan
 Stores the requirements for the Vulkan video backend. More...
 
struct  fplVideoSurface
 Stores the surface properties for the active video backend. More...
 
struct  fplVideoSurfaceOpenGL
 Stores the surface properties for the OpenGL video backend. More...
 
struct  fplVideoSurfaceVulkan
 Stores the surface properties for the Vulkan video backend. More...
 
union  fplVideoWindow
 Stores the video window handles. More...
 

Typedefs

typedef struct fplVideoBackBuffer fplVideoBackBuffer
 A structure containing video backbuffer properties.
 
typedef struct fplVideoRect fplVideoRect
 A structure defining a video rectangles position and size.
 
typedef union fplVideoRequirements fplVideoRequirements
 Stores the video requirements for the desired video backend.
 
typedef struct fplVideoRequirementsVulkan fplVideoRequirementsVulkan
 Stores the requirements for the Vulkan video backend.
 
typedef struct fplVideoSurface fplVideoSurface
 Stores the surface properties for the active video backend.
 
typedef struct fplVideoSurfaceOpenGL fplVideoSurfaceOpenGL
 Stores the surface properties for the OpenGL video backend.
 
typedef struct fplVideoSurfaceVulkan fplVideoSurfaceVulkan
 Stores the surface properties for the Vulkan video backend.
 
typedef union fplVideoWindow fplVideoWindow
 Stores the video window handles.
 

Functions

fpl_inline fplVideoRect fplCreateVideoRectFromLTRB (int32_t left, int32_t top, int32_t right, int32_t bottom)
 Makes a video rectangle from a LTRB rectangle. More...
 
fpl_common_api fplVideoBackBufferfplGetVideoBackBuffer ()
 Retrieves the pointer to the current video backbuffer. More...
 
const fpl_common_api char * fplGetVideoBackendName (fplVideoBackendType backendType)
 Gets a string that represents the given video backend. More...
 
fpl_common_api fplVideoBackendType fplGetVideoBackendType ()
 Gets the current video backend. More...
 
const fpl_common_api void * fplGetVideoProcedure (const char *procName)
 Gets the procedure by the specified name from the active video backend. More...
 
fpl_common_api bool fplGetVideoRequirements (const fplVideoBackendType backendType, fplVideoRequirements *requirements)
 Gets the video requirements for the specified video backend. More...
 
const fpl_common_api fplVideoSurfacefplGetVideoSurface ()
 Gets the current fplVideoSurface that stores all handles used for the active video backend. More...
 
fpl_common_api bool fplResizeVideoBackBuffer (const uint32_t width, const uint32_t height)
 Resizes the current video backbuffer. More...
 
fpl_common_api void fplVideoFlip ()
 Forces the window to be redrawn or to swap the back/front buffer.
 

Detailed Description

This category contains functions for retrieving or resizing the video buffer.

Function Documentation

◆ fplCreateVideoRectFromLTRB()

fpl_inline fplVideoRect fplCreateVideoRectFromLTRB ( int32_t  left,
int32_t  top,
int32_t  right,
int32_t  bottom 
)

Makes a video rectangle from a LTRB rectangle.

Parameters
leftThe left position in screen units
topThe top position in screen units
rightThe right position in screen units
bottomThe bottom position in screen units
Returns
Returns the computed video rectangle fplVideoRect

Definition at line 6460 of file final_platform_layer.h.

◆ fplGetVideoBackBuffer()

fpl_common_api fplVideoBackBuffer* fplGetVideoBackBuffer ( )

Retrieves the pointer to the current video backbuffer.

Returns
Returns the pointer to the current fplVideoBackBuffer.
Warning
Do not release this memory by any means, otherwise you will corrupt heap memory!

◆ fplGetVideoBackendName()

const fpl_common_api char* fplGetVideoBackendName ( fplVideoBackendType  backendType)

Gets a string that represents the given video backend.

Parameters
backendTypeThe video backend type fplVideoBackendType
Returns
Returns a string for the given video backend type

◆ fplGetVideoBackendType()

fpl_common_api fplVideoBackendType fplGetVideoBackendType ( )

Gets the current video backend.

Returns
Returns the current video backend type fplVideoBackendType

◆ fplGetVideoProcedure()

const fpl_common_api void* fplGetVideoProcedure ( const char *  procName)

Gets the procedure by the specified name from the active video backend.

Parameters
procNameThe name of the procedure.
Returns
Returns the function pointer of the procedure.

◆ fplGetVideoRequirements()

fpl_common_api bool fplGetVideoRequirements ( const fplVideoBackendType  backendType,
fplVideoRequirements requirements 
)

Gets the video requirements for the specified video backend.

Parameters
backendTypeThe fplVideoBackendType
requirementsThe reference to the fplVideoRequirements
Returns
Returns true when the fplVideoRequirements are filled out, false otherwise.

◆ fplGetVideoSurface()

const fpl_common_api fplVideoSurface* fplGetVideoSurface ( )

Gets the current fplVideoSurface that stores all handles used for the active video backend.

Returns
The resulting fplVideoSurface reference.

◆ fplResizeVideoBackBuffer()

fpl_common_api bool fplResizeVideoBackBuffer ( const uint32_t  width,
const uint32_t  height 
)

Resizes the current video backbuffer.

Parameters
widthThe width in pixels
heightThe height in pixels
Returns
Returns true when video back buffer could be resized, false otherwise.