crtc/kms: Document meta_crtc_kms_get_modifiers

It has some details that may not be obvious from the function signature.

https://gitlab.gnome.org/GNOME/mutter/merge_requests/341
This commit is contained in:
Pekka Paalanen 2018-11-21 15:12:32 +02:00 committed by Jonas Ådahl
parent 8a0d0ce987
commit 7f2dbb6c44

View File

@ -179,6 +179,20 @@ find_property_index (MetaGpu *gpu,
return -1;
}
/**
* meta_crtc_kms_get_modifiers:
* @crtc: a #MetaCrtc object that has to be a #MetaCrtcKms
* @format: a DRM pixel format
*
* Returns a pointer to a #GArray containing all the supported
* modifiers for the given DRM pixel format on the CRTC's primary
* plane. The array element type is uint64_t.
*
* The caller must not modify or destroy the array or its contents.
*
* Returns NULL if the modifiers are not known or the format is not
* supported.
*/
GArray *
meta_crtc_kms_get_modifiers (MetaCrtc *crtc,
uint32_t format)