---
name: "drm_plane_helper_check_update"
section: "9"
platform: "linux"
package: "linux-manual-3.16"
version: "3.16.56-1+deb8u1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/drm_plane_helper_check_update"
---

# drm\_plane\_helper\_check\_update(9)

Check plane update for validity

## NAME

drm\_plane\_helper\_check\_update - Check plane update for validity

## SYNOPSIS

**int drm\_plane\_helper\_check\_update(struct drm\_plane \*** *plane***, struct drm\_crtc \*** *crtc***, struct drm\_framebuffer \*** *fb***, struct drm\_rect \*** *src***, struct drm\_rect \*** *dest***, const struct drm\_rect \*** *clip***, int** *min\_scale***, int** *max\_scale***, bool** *can\_position***, bool** *can\_update\_disabled***, bool \*** *visible***);**

## ARGUMENTS

*plane*

plane object to update

*crtc*

owning CRTC of owning plane

*fb*

framebuffer to flip onto plane

*src*

source coordinates in 16.16 fixed point

*dest*

integer destination coordinates

*clip*

integer clipping coordinates

*min\_scale*

minimum *src*:*dest* scaling factor in 16.16 fixed point

*max\_scale*

maximum *src*:*dest* scaling factor in 16.16 fixed point

*can\_position*

is it legal to position the plane such that it doesn't cover the entire crtc? This will generally only be false for primary planes.

*can\_update\_disabled*

can the plane be updated while the crtc is disabled?

*visible*

output parameter indicating whether plane is still visible after clipping

## DESCRIPTION

Checks that a desired plane update is valid. Drivers that provide their own plane handling rather than helper-provided implementations may still wish to call this function to avoid duplication of error checking code.

## RETURNS

Zero if update appears valid, error code on failure

## AUTHORS

**Jesse Barnes** \<jesse.barnes@intel.com\>\
 Intel Corporation,

Initial version

**Laurent Pinchart** \<laurent.pinchart@ideasonboard.com\>\
 Ideas on board SPRL,

Driver internals

**Daniel Vetter** \<daniel.vetter@ffwll.ch\>\
 Intel Corporation,

Contributions all over the place

## COPYRIGHT