vlc_vout_display.h File Reference

#include <vlc_es.h>
#include <vlc_picture.h>
#include <vlc_picture_pool.h>
#include <vlc_subpicture.h>
#include <vlc_keys.h>
#include <vlc_mouse.h>
#include <vlc_vout_window.h>

Go to the source code of this file.

Classes
struct	vout_display_cfg_t
struct	vout_display_info_t
struct	vout_display_owner_t
struct	vout_display_t
struct	vout_display_place_t

Typedefs
typedef struct vout_display_t	vout_display_t
typedef struct vout_display_sys_t	vout_display_sys_t
typedef struct vout_display_owner_t	vout_display_owner_t
typedef struct vout_display_owner_sys_t	vout_display_owner_sys_t

Enumerations
enum	vout_display_align_t {   VOUT_DISPLAY_ALIGN_CENTER, VOUT_DISPLAY_ALIGN_LEFT, VOUT_DISPLAY_ALIGN_RIGHT, VOUT_DISPLAY_ALIGN_TOP,   VOUT_DISPLAY_ALIGN_BOTTOM }
enum	{ VOUT_WINDOW_STATE_NORMAL =0, VOUT_WINDOW_STATE_ABOVE =1, VOUT_WINDOW_STATE_BELOW =2, VOUT_WINDOW_STACK_MASK =3 }
enum	{   VOUT_DISPLAY_HIDE_MOUSE, VOUT_DISPLAY_RESET_PICTURES, VOUT_DISPLAY_CHANGE_FULLSCREEN, VOUT_DISPLAY_CHANGE_WINDOW_STATE,   VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, VOUT_DISPLAY_CHANGE_ZOOM, VOUT_DISPLAY_CHANGE_SOURCE_ASPECT,   VOUT_DISPLAY_CHANGE_SOURCE_CROP, VOUT_DISPLAY_GET_OPENGL }
enum	{   VOUT_DISPLAY_EVENT_PICTURES_INVALID, VOUT_DISPLAY_EVENT_FULLSCREEN, VOUT_DISPLAY_EVENT_WINDOW_STATE, VOUT_DISPLAY_EVENT_DISPLAY_SIZE,   VOUT_DISPLAY_EVENT_CLOSE, VOUT_DISPLAY_EVENT_KEY, VOUT_DISPLAY_EVENT_MOUSE_STATE, VOUT_DISPLAY_EVENT_MOUSE_MOVED,   VOUT_DISPLAY_EVENT_MOUSE_PRESSED, VOUT_DISPLAY_EVENT_MOUSE_RELEASED, VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK }

Functions
VLC_API void	vout_display_GetDefaultDisplaySize (unsigned *width, unsigned *height, const video_format_t *source, const vout_display_cfg_t *)
VLC_API void	vout_display_PlacePicture (vout_display_place_t *place, const video_format_t *source, const vout_display_cfg_t *cfg, bool do_clipping)

Detailed Description

This file defines vout display structures and functions in vlc

Enumeration Type Documentation

anonymous enum

Window management state.

anonymous enum

Control query for vout_display_t

anonymous enum

Event from vout_display_t

Events modifiying the state may be sent multiple times. Only the transition will be retained and acted upon.

enum vout_display_align_t

Possible alignments for vout_display.

Function Documentation

VLC_API void vout_display_GetDefaultDisplaySize	(	unsigned *	width,
		unsigned *	height,
		const video_format_t *	source,
		const vout_display_cfg_t *
	)

Computes the default display size given the source and the display configuration.

This asssumes that the picture is already cropped.

VLC_API void vout_display_PlacePicture	(	vout_display_place_t *	place,
		const video_format_t *	source,
		const vout_display_cfg_t *	cfg,
		bool	do_clipping
	)

Computes how to place a picture inside the display to respect the given parameters. This assumes that cropping is done by an external mean.

Parameters

p_place	Place inside the window (window pixel unit)
p_source	Video source format
p_cfg	Display configuration
b_clip	If true, prevent the video to go outside the display (break zoom).