'\" t
.\"     Title: drm_plane_helper_check_update
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: May 2018
.\"    Manual: DRM Core
.\"    Source: Kernel Hackers Manual 3.16.56
.\"  Language: English
.\"
.TH "DRM_PLANE_HELPER_CHE" "9" "May 2018" "Kernel Hackers Manual 3\&.16\&" "DRM Core"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
drm_plane_helper_check_update \- Check plane update for validity
.SH "SYNOPSIS"
.HP \w'int\ drm_plane_helper_check_update('u
.BI "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" ");"
.SH "ARGUMENTS"
.PP
\fIplane\fR
.RS 4
plane object to update
.RE
.PP
\fIcrtc\fR
.RS 4
owning CRTC of owning plane
.RE
.PP
\fIfb\fR
.RS 4
framebuffer to flip onto plane
.RE
.PP
\fIsrc\fR
.RS 4
source coordinates in 16\&.16 fixed point
.RE
.PP
\fIdest\fR
.RS 4
integer destination coordinates
.RE
.PP
\fIclip\fR
.RS 4
integer clipping coordinates
.RE
.PP
\fImin_scale\fR
.RS 4
minimum
\fIsrc\fR:\fIdest\fR
scaling factor in 16\&.16 fixed point
.RE
.PP
\fImax_scale\fR
.RS 4
maximum
\fIsrc\fR:\fIdest\fR
scaling factor in 16\&.16 fixed point
.RE
.PP
\fIcan_position\fR
.RS 4
is it legal to position the plane such that it doesn\*(Aqt cover the entire crtc? This will generally only be false for primary planes\&.
.RE
.PP
\fIcan_update_disabled\fR
.RS 4
can the plane be updated while the crtc is disabled?
.RE
.PP
\fIvisible\fR
.RS 4
output parameter indicating whether plane is still visible after clipping
.RE
.SH "DESCRIPTION"
.PP
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\&.
.SH "RETURNS"
.PP
Zero if update appears valid, error code on failure
.SH "AUTHORS"
.PP
\fBJesse Barnes\fR <\&jesse.barnes@intel.com\&>
.br
Intel Corporation, 
	    
	  
.RS 4
Initial version
.RE
.PP
\fBLaurent Pinchart\fR <\&laurent.pinchart@ideasonboard.com\&>
.br
Ideas on board SPRL, 
	    
	  
.RS 4
Driver internals
.RE
.PP
\fBDaniel Vetter\fR <\&daniel.vetter@ffwll.ch\&>
.br
Intel Corporation, 
	    
	  
.RS 4
Contributions all over the place
.RE
.SH "COPYRIGHT"
.br