callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Try to steer people away from gdk_pixbuf_get_from_window()

Browse Source 
It's a bad function, and people should feel bad about using it.
This commit is contained in:
Emmanuele Bassi 2023-03-26 15:59:14 +01:00
parent 789d202720
commit bda80c4e41
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gdk/gdkpixbuf-drawable.c
View File

@ -51,9 +51,11 @@
* @height: Height in pixels of region to get * @height: Height in pixels of region to get
* *
* Transfers image data from a #GdkWindow and converts it to an RGB(A) * Transfers image data from a #GdkWindow and converts it to an RGB(A)
* representation inside a #GdkPixbuf. In other words, copies * representation inside a #GdkPixbuf.
* image data from a server-side drawable to a client-side RGB(A) buffer. *
* This allows you to efficiently read individual pixels on the client side. * In other words, copies image data from a server-side drawable to a
* client-side RGB(A) buffer. This allows you to efficiently read
* individual pixels on the client side.
* *
* This function will create an RGB pixbuf with 8 bits per channel with * This function will create an RGB pixbuf with 8 bits per channel with
* the size specified by the @width and @height arguments scaled by the * the size specified by the @width and @height arguments scaled by the
@ -62,7 +64,8 @@
* *
* If the window is off the screen, then there is no image data in the * If the window is off the screen, then there is no image data in the
* obscured/offscreen regions to be placed in the pixbuf. The contents of * obscured/offscreen regions to be placed in the pixbuf. The contents of
* portions of the pixbuf corresponding to the offscreen region are undefined. * portions of the pixbuf corresponding to the offscreen region are
* undefined.
* *
* If the window you’re obtaining data from is partially obscured by * If the window you’re obtaining data from is partially obscured by
* other windows, then the contents of the pixbuf areas corresponding * other windows, then the contents of the pixbuf areas corresponding
@ -74,8 +77,10 @@
* If memory can’t be allocated for the return value, %NULL will be returned * If memory can’t be allocated for the return value, %NULL will be returned
* instead. * instead.
* *
* (In short, there are several ways this function can fail, and if it fails * In short, there are several ways this function can fail, and if it fails
* it returns %NULL; so check the return value.) * it returns %NULL; so check the return value.
*
* You should rarely, if ever, need to call this function.
* *
* Returns: (nullable) (transfer full): A newly-created pixbuf with a * Returns: (nullable) (transfer full): A newly-created pixbuf with a
* reference count of 1, or %NULL on error * reference count of 1, or %NULL on error