MMAL_3-15-2015
Public Attributes | List of all members
MMAL_DISPLAYREGION_T Struct Reference

#include <mmal_parameters_video.h>

Public Attributes

MMAL_PARAMETER_HEADER_T hdr
 
uint32_t set
 
uint32_t display_num
 
MMAL_BOOL_T fullscreen
 
MMAL_DISPLAYTRANSFORM_T transform
 
MMAL_RECT_T dest_rect
 
MMAL_RECT_T src_rect
 
MMAL_BOOL_T noaspect
 
MMAL_DISPLAYMODE_T mode
 
uint32_t pixel_x
 
uint32_t pixel_y
 
int32_t layer
 
MMAL_BOOL_T copyprotect_required
 
uint32_t alpha
 

Detailed Description

This config sets the output display device, as well as the region used on the output display, any display transformation, and some flags to indicate how to scale the image.

Member Data Documentation

uint32_t MMAL_DISPLAYREGION_T::alpha

Level of opacity of the layer, where zero is fully transparent and 255 is fully opaque.

MMAL_BOOL_T MMAL_DISPLAYREGION_T::copyprotect_required

Set to non-zero to ensure copy protection is used on output.

MMAL_RECT_T MMAL_DISPLAYREGION_T::dest_rect

Where to display the frame within the screen, if fullscreen is zero.

uint32_t MMAL_DISPLAYREGION_T::display_num

Describes the display output device, with 0 typically being a directly connected LCD display. The actual values will depend on the hardware. Code using hard-wired numbers (e.g. 2) is certain to fail.

MMAL_BOOL_T MMAL_DISPLAYREGION_T::fullscreen

Indicates that we are using the full device screen area, rather than a window of the display. If zero, then dest_rect is used to specify a region of the display to use.

int32_t MMAL_DISPLAYREGION_T::layer

Sets the relative depth of the images, with greater values being in front of smaller values.

MMAL_DISPLAYMODE_T MMAL_DISPLAYREGION_T::mode

Indicates how the image should be scaled to fit the display.

MMAL_DISPLAY_MODE_FILL

indicates that the image should fill the screen by potentially cropping the frames. Setting

mode

to

MMAL_DISPLAY_MODE_LETTERBOX

indicates that all the source region should be displayed and black bars added if necessary.

MMAL_BOOL_T MMAL_DISPLAYREGION_T::noaspect

If set to non-zero, indicates that any display scaling should disregard the aspect ratio of the frame region being displayed.

uint32_t MMAL_DISPLAYREGION_T::pixel_x

If non-zero, defines the width of a source pixel relative to

pixel_y

. If zero, then pixels default to being square.

uint32_t MMAL_DISPLAYREGION_T::pixel_y

If non-zero, defines the height of a source pixel relative to

pixel_x

. If zero, then pixels default to being square.

uint32_t MMAL_DISPLAYREGION_T::set

Bitfield that indicates which fields are set and should be used. All other fields will maintain their current value. MMAL_DISPLAYSET_T defines the bits that can be combined.

MMAL_RECT_T MMAL_DISPLAYREGION_T::src_rect

Indicates which area of the frame to display. If all values are zero, the whole frame will be used.

MMAL_DISPLAYTRANSFORM_T MMAL_DISPLAYREGION_T::transform

Indicates any rotation or flipping used to map frames onto the natural display orientation.

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