Video functions

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

Data Structures

Type	Name
struct	fplVideoBackBuffer A structure containing video backbuffer properties. More...
struct	fplVideoRect A structure defining a video rectangle's 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...

Functions

Type	Name
fpl_common_api fplVideoRect	fplCreateVideoRectFromLTRB (int32_t left, int32_t top, int32_t right, int32_t bottom) Makes a video rectangle from a LTRB rectangle.
fpl_common_api fplVideoBackBuffer *	fplGetVideoBackBuffer (void) Retrieves the pointer to the current video backbuffer.
fpl_common_api const char *	fplGetVideoBackendName (fplVideoBackendType backendType) Gets a string that represents the given video backend.
fpl_common_api fplVideoBackendType	fplGetVideoBackendType (void) Gets the current video backend.
fpl_common_api const void *	fplGetVideoProcedure (const char *procName) Gets the procedure by the specified name from the active video backend.
fpl_common_api bool	fplGetVideoRequirements (const fplVideoBackendType backendType, fplVideoRequirements *requirements) Gets the video requirements for the specified video backend.
fpl_common_api const fplVideoSurface *	fplGetVideoSurface (void) Gets the current video surface that stores all handles used for the active video backend.
fpl_common_api bool	fplResizeVideoBackBuffer (const uint32_t width, const uint32_t height) Resizes the current video backbuffer.
fpl_common_api void	fplVideoFlip (void) 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_common_api fplVideoRect fplCreateVideoRectFromLTRB ( int32_t left, int32_t top, int32_t right, int32_t bottom )

Makes a video rectangle from a LTRB rectangle.

Parameters

Direction	Parameter	Description
[in]	left	The left position in screen units.
[in]	top	The top position in screen units.
[in]	right	The right position in screen units.
[in]	bottom	The bottom position in screen units.

Returns: Returns the computed video rectangle.

fplGetVideoBackBuffer()

fpl_common_api fplVideoBackBuffer * fplGetVideoBackBuffer ( void )

Retrieves the pointer to the current video backbuffer.

Returns: Returns the pointer to the current video backbuffer

fplVideoBackBuffer .

Warning: Do not release this memory by any means, otherwise you will corrupt heap memory!

fplGetVideoBackendName()

fpl_common_api const char * fplGetVideoBackendName ( fplVideoBackendType backendType)

Gets a string that represents the given video backend.

Parameters

Direction	Parameter	Description
[in]	backendType	The video backend type fplVideoBackendType.

Returns: Returns a string for the given video backend type.

fplGetVideoBackendType()

fpl_common_api fplVideoBackendType fplGetVideoBackendType ( void )

Gets the current video backend.

Returns: Returns the current video backend type.

fplGetVideoProcedure()

fpl_common_api const void * fplGetVideoProcedure ( const char * procName)

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

Parameters

Direction	Parameter	Description
[in]	procName	The 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

Direction	Parameter	Description
[in]	backendType	The video backend type fplVideoBackendType.
[out]	requirements	Reference to the video requirements fplVideoRequirements.

Returns: Returns true when the video requirements are filled out, false otherwise.

fplGetVideoSurface()

fpl_common_api const fplVideoSurface * fplGetVideoSurface ( void )

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

Returns: The resulting video surface reference

fplVideoSurface .

fplResizeVideoBackBuffer()

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

Resizes the current video backbuffer.

Parameters

Direction	Parameter	Description
[in]	width	The width in pixels.
[in]	height	The height in pixels.

Returns: Returns true when the video backbuffer could be resized, false otherwise.