From 81357866051fe5049f7327081da257278a3a24a3 Mon Sep 17 00:00:00 2001 From: Chad Versace Date: Tue, 5 Jan 2016 11:28:49 -0800 Subject: [PATCH] isl: Document gen7_filter_tiling() --- src/isl/isl_gen7.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/isl/isl_gen7.c b/src/isl/isl_gen7.c index 9984f61b2a4..4484abb8191 100644 --- a/src/isl/isl_gen7.c +++ b/src/isl/isl_gen7.c @@ -185,6 +185,17 @@ gen7_format_needs_valign2(const struct isl_device *dev, format == ISL_FORMAT_R32G32B32_FLOAT; } +/** + * @brief Filter out tiling flags that are incompatible with the surface. + * + * The resultant outgoing @a flags is a subset of the incoming @a flags. The + * outgoing flags may be empty (0x0) if the incoming flags were too + * restrictive. + * + * For example, if the surface will be used for a display + * (ISL_SURF_USAGE_DISPLAY_BIT), then this function filters out all tiling + * flags except ISL_TILING_X_BIT and ISL_TILING_LINEAR_BIT. + */ void gen7_filter_tiling(const struct isl_device *dev, const struct isl_surf_init_info *restrict info, -- 2.30.2