Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/graphics/allocator/2.0/IAllocator.hal b/graphics/allocator/2.0/IAllocator.hal
index 00d07d5..bf0e141 100644
--- a/graphics/allocator/2.0/IAllocator.hal
+++ b/graphics/allocator/2.0/IAllocator.hal
@@ -20,23 +20,23 @@
interface IAllocator {
enum Capability : int32_t {
- /* reserved */
+ /** reserved */
INVALID = 0,
- /*
+ /**
* IAllocatorClient::testAllocate must always return UNDEFINED unless
* this capability is supported.
*/
TEST_ALLOCATE = 1,
- /*
+ /**
* IAllocatorClient::BufferDescriptorInfo::layerCount must be 1 unless
* this capability is supported.
*/
LAYERED_BUFFERS = 2,
};
- /*
+ /**
* Provides a list of supported capabilities (as described in the
* definition of Capability above). This list must not change after
* initialization.
@@ -48,7 +48,7 @@
@callflow(next="*")
getCapabilities() generates (vec<Capability> capabilities);
- /*
+ /**
* Retrieves implementation-defined debug information, which will be
* displayed during, for example, `dumpsys SurfaceFlinger`.
*
@@ -59,7 +59,7 @@
@callflow(next="*")
dumpDebugInfo() generates (string debugInfo);
- /*
+ /**
* Creates a client of the allocator. All resources created by the client
* are owned by the client and are only visible to the client, unless they
* are exported by exportHandle.
diff --git a/graphics/allocator/2.0/IAllocatorClient.hal b/graphics/allocator/2.0/IAllocatorClient.hal
index 080e3ea..8ca568f 100644
--- a/graphics/allocator/2.0/IAllocatorClient.hal
+++ b/graphics/allocator/2.0/IAllocatorClient.hal
@@ -20,7 +20,7 @@
interface IAllocatorClient {
struct BufferDescriptorInfo {
- /*
+ /**
* The width specifies how many columns of pixels must be in the
* allocated buffer, but does not necessarily represent the offset in
* columns between the same column in adjacent rows. The rows may be
@@ -28,34 +28,34 @@
*/
uint32_t width;
- /*
+ /**
* The height specifies how many rows of pixels must be in the
* allocated buffer.
*/
uint32_t height;
- /*
+ /**
* The number of image layers that must be in the allocated buffer.
*/
uint32_t layerCount;
- /* Buffer pixel format. */
+ /** Buffer pixel format. */
PixelFormat format;
- /*
+ /**
* Buffer producer usage mask; valid flags can be found in the
* definition of ProducerUsage.
*/
uint64_t producerUsageMask;
- /*
+ /**
* Buffer consumer usage mask; valid flags can be found in the
* definition of ConsumerUsage.
*/
uint64_t consumerUsageMask;
};
- /*
+ /**
* Creates a new, opaque buffer descriptor.
*
* @param descriptorInfo specifies the attributes of the buffer
@@ -71,7 +71,7 @@
generates (Error error,
BufferDescriptor descriptor);
- /*
+ /**
* Destroys an existing buffer descriptor.
*
* @param descriptor is the descriptor to destroy.
@@ -81,7 +81,7 @@
@callflow(next="*")
destroyDescriptor(BufferDescriptor descriptor) generates (Error error);
- /*
+ /**
* Tests whether a buffer allocation can succeed, ignoring potential
* resource contention which might lead to a NO_RESOURCES error.
*
@@ -98,7 +98,7 @@
@callflow(next="allocate")
testAllocate(vec<BufferDescriptor> descriptors) generates (Error error);
- /*
+ /**
* Attempts to allocate a list of buffers sharing a backing store.
*
* Each buffer must correspond to one of the descriptors passed into the
@@ -124,7 +124,7 @@
generates (Error error,
vec<Buffer> buffers);
- /*
+ /**
* Frees a buffer.
*
* @param buffer is the buffer to be freed.
@@ -135,7 +135,7 @@
@callflow(next="*")
free(Buffer buffer) generates (Error error);
- /*
+ /**
* Exports a buffer for use in other client libraries or for cross-process
* sharing.
*
diff --git a/graphics/allocator/2.0/types.hal b/graphics/allocator/2.0/types.hal
index f9d1e1b..d9b184b 100644
--- a/graphics/allocator/2.0/types.hal
+++ b/graphics/allocator/2.0/types.hal
@@ -17,130 +17,131 @@
package android.hardware.graphics.allocator@2.0;
enum Error : int32_t {
- NONE = 0, /* no error */
- BAD_DESCRIPTOR = 1, /* invalid BufferDescriptor */
- BAD_BUFFER = 2, /* invalid Buffer */
- BAD_VALUE = 3, /* invalid width, height, etc. */
- NOT_SHARED = 4, /* buffers not sharing backing store */
- NO_RESOURCES = 5, /* temporary failure due to resource contention */
- UNDEFINED = 6, /* an operation has no defined meaning */
- UNSUPPORTED = 7, /* permanent failure */
+ NONE = 0, /** no error */
+ BAD_DESCRIPTOR = 1, /** invalid BufferDescriptor */
+ BAD_BUFFER = 2, /** invalid Buffer */
+ BAD_VALUE = 3, /** invalid width, height, etc. */
+ NOT_SHARED = 4, /** buffers not sharing backing store */
+ NO_RESOURCES = 5, /** temporary failure due to resource contention */
+ UNDEFINED = 6, /** an operation has no defined meaning */
+ UNSUPPORTED = 7, /** permanent failure */
};
enum ProducerUsage : uint64_t {
- /* bit 0 is reserved */
+ /** bit 0 is reserved */
- /* buffer is read by CPU occasionally */
+ /** buffer is read by CPU occasionally */
CPU_READ = 1ULL << 1,
- /* buffer is read by CPU frequently */
+ /** buffer is read by CPU frequently */
CPU_READ_OFTEN = 1ULL << 2,
- /* bit 3 is reserved */
- /* bit 4 is reserved */
+ /** bit 3 is reserved */
+ /** bit 4 is reserved */
- /* buffer is written by CPU occasionally */
+ /** buffer is written by CPU occasionally */
CPU_WRITE = 1ULL << 5,
- /* buffer is written by CPU frequently */
+ /** buffer is written by CPU frequently */
CPU_WRITE_OFTEN = 1ULL << 6,
- /* bit 7 is reserved */
- /* bit 8 is reserved */
+ /** bit 7 is reserved */
+ /** bit 8 is reserved */
- /* buffer is used as a GPU render target */
+ /** buffer is used as a GPU render target */
GPU_RENDER_TARGET = 1ULL << 9,
- /* bit 10 is reserved */
- /* bit 11 is reserved */
- /* bit 12 is reserved */
- /* bit 13 is reserved */
+ /** bit 10 is reserved */
+ /** bit 11 is reserved */
+ /** bit 12 is reserved */
+ /** bit 13 is reserved */
- /*
+ /**
* Buffer is allocated with hardware-level protection against copying the
* contents (or information derived from the contents) into unprotected
* memory.
*/
PROTECTED = 1ULL << 14,
- /* bit 15 is reserved */
- /* bit 16 is reserved */
+ /** bit 15 is reserved */
+ /** bit 16 is reserved */
- /* buffer is used as a camera HAL output */
+ /** buffer is used as a camera HAL output */
CAMERA = 1ULL << 17,
- /* bit 18 is reserved */
- /* bit 19 is reserved */
- /* bit 20 is reserved */
- /* bit 21 is reserved */
+ /** bit 18 is reserved */
+ /** bit 19 is reserved */
+ /** bit 20 is reserved */
+ /** bit 21 is reserved */
- /* buffer is used as a video decoder output */
+ /** buffer is used as a video decoder output */
VIDEO_DECODER = 1ULL << 22,
- /* buffer is used as a sensor direct report output */
+ /** buffer is used as a sensor direct report output */
SENSOR_DIRECT_DATA = 1ULL << 23,
- /* bits 24-27 are reserved for future versions */
- /* bits 28-31 are reserved for vendor extensions */
+ /** bits 24-27 are reserved for future versions */
+ /** bits 28-31 are reserved for vendor extensions */
- /* bits 32-47 are reserved for future versions */
- /* bits 48-63 are reserved for vendor extensions */
+ /** bits 32-47 are reserved for future versions */
+ /** bits 48-63 are reserved for vendor extensions */
};
enum ConsumerUsage : uint64_t {
- /* bit 0 is reserved */
+ /** bit 0 is reserved */
- /* buffer is read by CPU occasionally */
+ /** buffer is read by CPU occasionally */
CPU_READ = 1ULL << 1,
- /* buffer is read by CPU frequently */
+ /** buffer is read by CPU frequently */
CPU_READ_OFTEN = 1ULL << 2,
- /* bit 3 is reserved */
- /* bit 4 is reserved */
- /* bit 5 is reserved */
- /* bit 6 is reserved */
- /* bit 7 is reserved */
+ /** bit 3 is reserved */
+ /** bit 4 is reserved */
+ /** bit 5 is reserved */
+ /** bit 6 is reserved */
+ /** bit 7 is reserved */
- /* buffer is used as a GPU texture */
+ /** buffer is used as a GPU texture */
GPU_TEXTURE = 1ULL << 8,
- /* bit 9 is reserved */
- /* bit 10 is reserved */
+ /** bit 9 is reserved */
+ /** bit 10 is reserved */
- /* buffer is used by hwcomposer HAL */
+ /** buffer is used by hwcomposer HAL */
HWCOMPOSER = 1ULL << 11,
- /* buffer is a hwcomposer HAL client target */
+ /** buffer is a hwcomposer HAL client target */
CLIENT_TARGET = 1ULL << 12,
- /* bit 13 is reserved */
- /* bit 14 is reserved */
+ /** bit 13 is reserved */
+ /** bit 14 is reserved */
- /* buffer is used as a hwcomposer HAL cursor */
+ /** buffer is used as a hwcomposer HAL cursor */
CURSOR = 1ULL << 15,
- /* buffer is used as a video encoder input */
+ /** buffer is used as a video encoder input */
VIDEO_ENCODER = 1ULL << 16,
- /* bit 17 is reserved */
+ /** bit 17 is reserved */
- /* buffer is used as a camera HAL input */
+ /** buffer is used as a camera HAL input */
CAMERA = 1ULL << 18,
- /* bit 19 is reserved */
+ /** bit 19 is reserved */
- /* buffer is used as a renderscript allocation */
+ /** buffer is used as a renderscript allocation */
RENDERSCRIPT = 1ULL << 20,
- /* bit 21 is reserved */
- /* bit 22 is reserved */
+ /** bit 21 is reserved */
+ /** bit 22 is reserved */
- /* buffer is used as as an OpenGL shader storage or uniform
+ /**
+ * buffer is used as as an OpenGL shader storage or uniform
buffer object */
GPU_DATA_BUFFER = 1ULL << 23,
- /* bits 24-27 are reserved for future versions */
- /* bits 28-31 are reserved for vendor extensions */
+ /** bits 24-27 are reserved for future versions */
+ /** bits 28-31 are reserved for vendor extensions */
- /* bits 32-47 are reserved for future versions */
- /* bits 48-63 are reserved for vendor extensions */
+ /** bits 32-47 are reserved for future versions */
+ /** bits 48-63 are reserved for vendor extensions */
};
typedef uint64_t BufferDescriptor;
diff --git a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
index c59a16c..87bb814 100644
--- a/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
+++ b/graphics/bufferqueue/1.0/IGraphicBufferProducer.hal
@@ -546,7 +546,7 @@
*/
disconnect(
int32_t api,
- DisconnectMode mode /* = DisconnectMode::API */
+ DisconnectMode mode /** = DisconnectMode::API */
) generates (
Status status
);
diff --git a/graphics/common/1.0/types.hal b/graphics/common/1.0/types.hal
index dfecec1..979e4c4 100644
--- a/graphics/common/1.0/types.hal
+++ b/graphics/common/1.0/types.hal
@@ -21,7 +21,7 @@
*/
@export(name="android_pixel_format_t", value_prefix="HAL_PIXEL_FORMAT_")
enum PixelFormat : int32_t {
- /*
+ /**
* "linear" color pixel formats:
*
* When used with ANativeWindow, the dataSpace field describes the color
@@ -37,7 +37,7 @@
RGB_565 = 4,
BGRA_8888 = 5,
- /*
+ /**
* The following formats use 10bit integers for R, G, and B and
* 2 bits for alpha. This is used to improve color precision on
* wide-color devices, e.g. Display-P3 or scRGB.
@@ -47,7 +47,7 @@
*/
RGBA_1010102 = 0x2B,
- /*
+ /**
* The following formats use a 16bit float per color component.
*
* When used with ANativeWindow, the dataSpace field describes the color
@@ -55,7 +55,7 @@
*/
RGBA_FP16 = 0x16,
- /*
+ /**
* 0x101 - 0x1FF
*
* This range is reserved for pixel formats that are specific to the HAL
@@ -66,7 +66,7 @@
* GL_OES_EGL_image_external OpenGL ES extension.
*/
- /*
+ /**
* Android YUV format:
*
* This format is exposed outside of the HAL to software decoders and
@@ -95,7 +95,7 @@
YV12 = 0x32315659, // YCrCb 4:2:0 Planar
- /*
+ /**
* Android Y8 format:
*
* This format is exposed outside of the HAL to the framework.
@@ -120,7 +120,7 @@
*/
Y8 = 0x20203859,
- /*
+ /**
* Android Y16 format:
*
* This format is exposed outside of the HAL to the framework.
@@ -149,7 +149,7 @@
*/
Y16 = 0x20363159,
- /*
+ /**
* Android RAW sensor format:
*
* This format is exposed outside of the camera HAL to applications.
@@ -187,7 +187,7 @@
*/
RAW16 = 0x20,
- /*
+ /**
* Android RAW10 format:
*
* This format is exposed outside of the camera HAL to applications.
@@ -241,7 +241,7 @@
*/
RAW10 = 0x25,
- /*
+ /**
* Android RAW12 format:
*
* This format is exposed outside of camera HAL to applications.
@@ -291,7 +291,7 @@
*/
RAW12 = 0x26,
- /*
+ /**
* Android opaque RAW format:
*
* This format is exposed outside of the camera HAL to applications.
@@ -312,7 +312,7 @@
*/
RAW_OPAQUE = 0x24,
- /*
+ /**
* Android binary blob graphics buffer format:
*
* This format is used to carry task-specific data which does not have a
@@ -338,7 +338,7 @@
*/
BLOB = 0x21,
- /*
+ /**
* Android format indicating that the choice of format is entirely up to the
* device-specific Gralloc implementation.
*
@@ -356,7 +356,7 @@
*/
IMPLEMENTATION_DEFINED = 0x22,
- /*
+ /**
* Android flexible YCbCr 4:2:0 formats
*
* This format allows platforms to use an efficient YCbCr/YCrCb 4:2:0
@@ -378,7 +378,7 @@
*/
YCBCR_420_888 = 0x23,
- /*
+ /**
* Android flexible YCbCr 4:2:2 formats
*
* This format allows platforms to use an efficient YCbCr/YCrCb 4:2:2
@@ -392,7 +392,7 @@
*/
YCBCR_422_888 = 0x27,
- /*
+ /**
* Android flexible YCbCr 4:4:4 formats
*
* This format allows platforms to use an efficient YCbCr/YCrCb 4:4:4
@@ -406,7 +406,7 @@
*/
YCBCR_444_888 = 0x28,
- /*
+ /**
* Android flexible RGB 888 formats
*
* This format allows platforms to use an efficient RGB/BGR/RGBX/BGRX
@@ -420,7 +420,7 @@
*/
FLEX_RGB_888 = 0x29,
- /*
+ /**
* Android flexible RGBA 8888 formats
*
* This format allows platforms to use an efficient RGBA/BGRA/ARGB/ABGR
@@ -434,7 +434,7 @@
*/
FLEX_RGBA_8888 = 0x2A,
- /* Legacy formats (deprecated), used by ImageFormat.java */
+ /** Legacy formats (deprecated), used by ImageFormat.java */
YCBCR_422_SP = 0x10, // NV16
YCRCB_420_SP = 0x11, // NV21
YCBCR_422_I = 0x14, // YUY2
@@ -450,18 +450,19 @@
*/
@export(name="android_transform_t", value_prefix="HAL_TRANSFORM_")
enum Transform : int32_t {
- /* flip source image horizontally (around the vertical axis) */
+ /** flip source image horizontally (around the vertical axis) */
FLIP_H = 0x01,
- /* flip source image vertically (around the horizontal axis)*/
+ /**
+ * flip source image vertically (around the horizontal axis)*/
FLIP_V = 0x02,
- /* rotate source image 90 degrees clockwise */
+ /** rotate source image 90 degrees clockwise */
ROT_90 = 0x04,
- /* rotate source image 180 degrees */
+ /** rotate source image 180 degrees */
ROT_180 = 0x03,
- /* rotate source image 270 degrees clockwise */
+ /** rotate source image 270 degrees clockwise */
ROT_270 = 0x07,
- /* 0x08 is reserved */
+ /** 0x08 is reserved */
};
/**
@@ -509,7 +510,7 @@
*/
@export(name="android_dataspace_t", value_prefix="HAL_DATASPACE_")
enum Dataspace : int32_t {
- /*
+ /**
* Default-assumption data space, when not explicitly specified.
*
* It is safest to assume the buffer is an image with sRGB primaries and
@@ -520,7 +521,7 @@
*/
UNKNOWN = 0x0,
- /*
+ /**
* Arbitrary dataspace with manually defined characteristics. Definition
* for colorspaces or other meaning must be communicated separately.
*
@@ -533,7 +534,7 @@
*/
ARBITRARY = 0x1,
- /*
+ /**
* Color-description aspects
*
* The following aspects define various characteristics of the color
@@ -543,7 +544,7 @@
STANDARD_SHIFT = 16,
- /*
+ /**
* Standard aspect
*
* Defines the chromaticity coordinates of the source primaries in terms of
@@ -551,7 +552,7 @@
*/
STANDARD_MASK = 63 << STANDARD_SHIFT, // 0x3F
- /*
+ /**
* Chromacity coordinates are unknown or are determined by the application.
* Implementations shall use the following suggested standards:
*
@@ -566,7 +567,7 @@
*/
STANDARD_UNSPECIFIED = 0 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.300 0.600
* blue 0.150 0.060
@@ -578,7 +579,7 @@
*/
STANDARD_BT709 = 1 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.290 0.600
* blue 0.150 0.060
@@ -592,7 +593,7 @@
*/
STANDARD_BT601_625 = 2 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.290 0.600
* blue 0.150 0.060
@@ -604,7 +605,7 @@
*/
STANDARD_BT601_625_UNADJUSTED = 3 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.310 0.595
* blue 0.155 0.070
@@ -618,7 +619,7 @@
*/
STANDARD_BT601_525 = 4 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.310 0.595
* blue 0.155 0.070
@@ -630,7 +631,7 @@
*/
STANDARD_BT601_525_UNADJUSTED = 5 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.170 0.797
* blue 0.131 0.046
@@ -642,7 +643,7 @@
*/
STANDARD_BT2020 = 6 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.170 0.797
* blue 0.131 0.046
@@ -654,7 +655,7 @@
*/
STANDARD_BT2020_CONSTANT_LUMINANCE = 7 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.21 0.71
* blue 0.14 0.08
@@ -666,7 +667,7 @@
*/
STANDARD_BT470M = 8 << STANDARD_SHIFT,
- /*
+ /**
* Primaries: x y
* green 0.243 0.692
* blue 0.145 0.049
@@ -678,7 +679,7 @@
*/
STANDARD_FILM = 9 << STANDARD_SHIFT,
- /*
+ /**
* SMPTE EG 432-1 and SMPTE RP 431-2. (DCI-P3)
* Primaries: x y
* green 0.265 0.690
@@ -688,7 +689,7 @@
*/
STANDARD_DCI_P3 = 10 << STANDARD_SHIFT,
- /*
+ /**
* Adobe RGB
* Primaries: x y
* green 0.210 0.710
@@ -702,7 +703,7 @@
TRANSFER_SHIFT = 22,
- /*
+ /**
* Transfer aspect
*
* Transfer characteristics are the opto-electronic transfer characteristic
@@ -718,7 +719,7 @@
TRANSFER_MASK = 31 << TRANSFER_SHIFT, // 0x1F
- /*
+ /**
* Transfer characteristics are unknown or are determined by the
* application.
*
@@ -732,7 +733,7 @@
*/
TRANSFER_UNSPECIFIED = 0 << TRANSFER_SHIFT,
- /*
+ /**
* Transfer characteristic curve:
* E = L
* L - luminance of image 0 <= L <= 1 for conventional colorimetry
@@ -740,7 +741,7 @@
*/
TRANSFER_LINEAR = 1 << TRANSFER_SHIFT,
- /*
+ /**
* Transfer characteristic curve:
*
* E = 1.055 * L^(1/2.4) - 0.055 for 0.0031308 <= L <= 1
@@ -750,7 +751,7 @@
*/
TRANSFER_SRGB = 2 << TRANSFER_SHIFT,
- /*
+ /**
* BT.601 525, BT.601 625, BT.709, BT.2020
*
* Transfer characteristic curve:
@@ -761,7 +762,7 @@
*/
TRANSFER_SMPTE_170M = 3 << TRANSFER_SHIFT,
- /*
+ /**
* Assumed display gamma 2.2.
*
* Transfer characteristic curve:
@@ -771,7 +772,7 @@
*/
TRANSFER_GAMMA2_2 = 4 << TRANSFER_SHIFT,
- /*
+ /**
* display gamma 2.6.
*
* Transfer characteristic curve:
@@ -781,7 +782,7 @@
*/
TRANSFER_GAMMA2_6 = 5 << TRANSFER_SHIFT,
- /*
+ /**
* display gamma 2.8.
*
* Transfer characteristic curve:
@@ -791,7 +792,7 @@
*/
TRANSFER_GAMMA2_8 = 6 << TRANSFER_SHIFT,
- /*
+ /**
* SMPTE ST 2084 (Dolby Perceptual Quantizer)
*
* Transfer characteristic curve:
@@ -807,7 +808,7 @@
*/
TRANSFER_ST2084 = 7 << TRANSFER_SHIFT,
- /*
+ /**
* ARIB STD-B67 Hybrid Log Gamma
*
* Transfer characteristic curve:
@@ -825,7 +826,7 @@
RANGE_SHIFT = 27,
- /*
+ /**
* Range aspect
*
* Defines the range of values corresponding to the unit range of 0-1.
@@ -833,7 +834,7 @@
*/
RANGE_MASK = 7 << RANGE_SHIFT, // 0x7
- /*
+ /**
* Range is unknown or are determined by the application. Implementations
* shall use the following suggested ranges:
*
@@ -846,13 +847,13 @@
*/
RANGE_UNSPECIFIED = 0 << RANGE_SHIFT,
- /*
+ /**
* Full range uses all values for Y, Cb and Cr from
* 0 to 2^b-1, where b is the bit depth of the color format.
*/
RANGE_FULL = 1 << RANGE_SHIFT,
- /*
+ /**
* Limited range uses values 16/256*2^b to 235/256*2^b for Y, and
* 1/16*2^b to 15/16*2^b for Cb, Cr, R, G and B, where b is the bit depth of
* the color format.
@@ -867,7 +868,7 @@
*/
RANGE_LIMITED = 2 << RANGE_SHIFT,
- /*
+ /**
* Extended range is used for scRGB. Intended for use with
* floating point pixel formats. [0.0 - 1.0] is the standard
* sRGB space. Values outside the range 0.0 - 1.0 can encode
@@ -876,11 +877,11 @@
*/
RANGE_EXTENDED = 3 << RANGE_SHIFT,
- /*
+ /**
* Legacy dataspaces
*/
- /*
+ /**
* sRGB linear encoding:
*
* The red, green, and blue components are stored in sRGB space, but
@@ -895,7 +896,7 @@
V0_SRGB_LINEAR = STANDARD_BT709 | TRANSFER_LINEAR | RANGE_FULL,
- /*
+ /**
* scRGB linear encoding:
*
* The red, green, and blue components are stored in extended sRGB space,
@@ -910,7 +911,7 @@
V0_SCRGB_LINEAR = STANDARD_BT709 | TRANSFER_LINEAR | RANGE_EXTENDED,
- /*
+ /**
* sRGB gamma encoding:
*
* The red, green and blue components are stored in sRGB space, and
@@ -928,7 +929,7 @@
V0_SRGB = STANDARD_BT709 | TRANSFER_SRGB | RANGE_FULL,
- /*
+ /**
* scRGB:
*
* The red, green, and blue components are stored in extended sRGB space,
@@ -942,7 +943,7 @@
*/
V0_SCRGB = STANDARD_BT709 | TRANSFER_SRGB | RANGE_EXTENDED,
- /*
+ /**
* YCbCr Colorspaces
* -----------------
*
@@ -953,7 +954,7 @@
* at the source as a function of linear optical intensity (luminance).
*/
- /*
+ /**
* JPEG File Interchange Format (JFIF)
*
* Same model as BT.601-625, but all values (Y, Cb, Cr) range from 0 to 255
@@ -964,7 +965,7 @@
V0_JFIF = STANDARD_BT601_625 | TRANSFER_SMPTE_170M | RANGE_FULL,
- /*
+ /**
* ITU-R Recommendation 601 (BT.601) - 625-line
*
* Standard-definition television, 625 Lines (PAL)
@@ -976,7 +977,7 @@
V0_BT601_625 = STANDARD_BT601_625 | TRANSFER_SMPTE_170M | RANGE_LIMITED,
- /*
+ /**
* ITU-R Recommendation 601 (BT.601) - 525-line
*
* Standard-definition television, 525 Lines (NTSC)
@@ -987,7 +988,7 @@
V0_BT601_525 = STANDARD_BT601_525 | TRANSFER_SMPTE_170M | RANGE_LIMITED,
- /*
+ /**
* ITU-R Recommendation 709 (BT.709)
*
* High-definition television
@@ -999,7 +1000,7 @@
V0_BT709 = STANDARD_BT709 | TRANSFER_SMPTE_170M | RANGE_LIMITED,
- /*
+ /**
* SMPTE EG 432-1 and SMPTE RP 431-2.
*
* Digital Cinema DCI-P3
@@ -1009,7 +1010,7 @@
DCI_P3_LINEAR = STANDARD_DCI_P3 | TRANSFER_LINEAR | RANGE_FULL,
- /*
+ /**
* SMPTE EG 432-1 and SMPTE RP 431-2.
*
* Digital Cinema DCI-P3
@@ -1021,7 +1022,7 @@
DCI_P3 = STANDARD_DCI_P3 | TRANSFER_GAMMA2_6 | RANGE_FULL,
- /*
+ /**
* Display P3
*
* Display P3 uses same primaries and white-point as DCI-P3
@@ -1030,7 +1031,7 @@
DISPLAY_P3_LINEAR = STANDARD_DCI_P3 | TRANSFER_LINEAR | RANGE_FULL,
- /*
+ /**
* Display P3
*
* Use same primaries and white-point as DCI-P3
@@ -1039,7 +1040,7 @@
DISPLAY_P3 = STANDARD_DCI_P3 | TRANSFER_SRGB | RANGE_FULL,
- /*
+ /**
* Adobe RGB
*
* Use full range, gamma 2.2 transfer and Adobe RGB primaries
@@ -1049,7 +1050,7 @@
ADOBE_RGB = STANDARD_ADOBE_RGB | TRANSFER_GAMMA2_2 | RANGE_FULL,
- /*
+ /**
* ITU-R Recommendation 2020 (BT.2020)
*
* Ultra High-definition television
@@ -1059,7 +1060,7 @@
BT2020_LINEAR = STANDARD_BT2020 | TRANSFER_LINEAR | RANGE_FULL,
- /*
+ /**
* ITU-R Recommendation 2020 (BT.2020)
*
* Ultra High-definition television
@@ -1068,7 +1069,7 @@
*/
BT2020 = STANDARD_BT2020 | TRANSFER_SMPTE_170M | RANGE_FULL,
- /*
+ /**
* ITU-R Recommendation 2020 (BT.2020)
*
* Ultra High-definition television
@@ -1078,11 +1079,11 @@
BT2020_PQ = STANDARD_BT2020 | TRANSFER_ST2084 | RANGE_FULL,
- /*
+ /**
* Data spaces for non-color formats
*/
- /*
+ /**
* The buffer contains depth ranging measurements from a depth camera.
* This value is valid with formats:
* HAL_PIXEL_FORMAT_Y16: 16-bit samples, consisting of a depth measurement
@@ -1103,7 +1104,7 @@
DEPTH = 0x1000,
- /*
+ /**
* The buffer contains sensor events from sensor direct report.
* This value is valid with formats:
* HAL_PIXEL_FORMAT_BLOB: an array of sensor event structure that forms
@@ -1113,7 +1114,7 @@
SENSOR = 0x1001
};
-/*
+/**
* Color modes that may be supported by a display.
*
* Definitions:
@@ -1159,7 +1160,7 @@
*/
@export(name="android_color_mode_t", value_prefix="HAL_COLOR_MODE_")
enum ColorMode : int32_t {
- /*
+ /**
* DEFAULT is the "native" gamut of the display.
* White Point: Vendor/OEM defined
* Panel Gamma: Vendor/OEM defined (typically 2.2)
@@ -1167,7 +1168,7 @@
*/
NATIVE = 0,
- /*
+ /**
* STANDARD_BT601_625 corresponds with display
* settings that implement the ITU-R Recommendation BT.601
* or Rec 601. Using 625 line version
@@ -1193,7 +1194,7 @@
*/
STANDARD_BT601_625 = 1,
- /*
+ /**
* Primaries:
* x y
* green 0.290 0.600
@@ -1213,7 +1214,7 @@
*/
STANDARD_BT601_625_UNADJUSTED = 2,
- /*
+ /**
* Primaries:
* x y
* green 0.310 0.595
@@ -1235,7 +1236,7 @@
*/
STANDARD_BT601_525 = 3,
- /*
+ /**
* Primaries:
* x y
* green 0.310 0.595
@@ -1255,7 +1256,7 @@
*/
STANDARD_BT601_525_UNADJUSTED = 4,
- /*
+ /**
* REC709 corresponds with display settings that implement
* the ITU-R Recommendation BT.709 / Rec. 709 for high-definition television.
* Rendering Intent: Colorimetric
@@ -1283,7 +1284,7 @@
*/
STANDARD_BT709 = 5,
- /*
+ /**
* DCI_P3 corresponds with display settings that implement
* SMPTE EG 432-1 and SMPTE RP 431-2
* Rendering Intent: Colorimetric
@@ -1298,7 +1299,7 @@
*/
DCI_P3 = 6,
- /*
+ /**
* SRGB corresponds with display settings that implement
* the sRGB color space. Uses the same primaries as ITU-R Recommendation
* BT.709
@@ -1326,7 +1327,7 @@
*/
SRGB = 7,
- /*
+ /**
* ADOBE_RGB corresponds with the RGB color space developed
* by Adobe Systems, Inc. in 1998.
* Rendering Intent: Colorimetric
@@ -1341,7 +1342,7 @@
*/
ADOBE_RGB = 8,
- /*
+ /**
* DISPLAY_P3 is a color space that uses the DCI_P3 primaries,
* the D65 white point and the SRGB transfer functions.
* Rendering Intent: Colorimetric
@@ -1364,46 +1365,47 @@
DISPLAY_P3 = 9
};
-/*
+/**
* Color transforms that may be applied by hardware composer to the whole
* display.
*/
@export(name="android_color_transform_t", value_prefix="HAL_COLOR_TRANSFORM_")
enum ColorTransform : int32_t {
- /* Applies no transform to the output color */
+ /** Applies no transform to the output color */
IDENTITY = 0,
- /* Applies an arbitrary transform defined by a 4x4 affine matrix */
+ /** Applies an arbitrary transform defined by a 4x4 affine matrix */
ARBITRARY_MATRIX = 1,
- /* Applies a transform that inverts the value or luminance of the color, but
+ /**
+ * Applies a transform that inverts the value or luminance of the color, but
* does not modify hue or saturation */
VALUE_INVERSE = 2,
- /* Applies a transform that maps all colors to shades of gray */
+ /** Applies a transform that maps all colors to shades of gray */
GRAYSCALE = 3,
- /* Applies a transform which corrects for protanopic color blindness */
+ /** Applies a transform which corrects for protanopic color blindness */
CORRECT_PROTANOPIA = 4,
- /* Applies a transform which corrects for deuteranopic color blindness */
+ /** Applies a transform which corrects for deuteranopic color blindness */
CORRECT_DEUTERANOPIA = 5,
- /* Applies a transform which corrects for tritanopic color blindness */
+ /** Applies a transform which corrects for tritanopic color blindness */
CORRECT_TRITANOPIA = 6
};
-/*
+/**
* Supported HDR formats. Must be kept in sync with equivalents in Display.java.
*/
@export(name="android_hdr_t", value_prefix="HAL_HDR_")
enum Hdr : int32_t {
- /* Device supports Dolby Vision HDR */
+ /** Device supports Dolby Vision HDR */
DOLBY_VISION = 1,
- /* Device supports HDR10 */
+ /** Device supports HDR10 */
HDR10 = 2,
- /* Device supports hybrid log-gamma HDR */
+ /** Device supports hybrid log-gamma HDR */
HLG = 3
};
diff --git a/graphics/composer/2.1/IComposer.hal b/graphics/composer/2.1/IComposer.hal
index 553a537..b3ac761 100644
--- a/graphics/composer/2.1/IComposer.hal
+++ b/graphics/composer/2.1/IComposer.hal
@@ -19,7 +19,7 @@
import IComposerClient;
interface IComposer {
- /*
+ /**
* Optional capabilities which may be supported by some devices. The
* particular set of supported capabilities for a given device may be
* retrieved using getCapabilities.
@@ -27,7 +27,7 @@
enum Capability : int32_t {
INVALID = 0,
- /*
+ /**
* Specifies that the device supports sideband stream layers, for
* which buffer content updates and other synchronization will not be
* provided through the usual validate/present cycle and must be
@@ -37,7 +37,7 @@
*/
SIDEBAND_STREAM = 1,
- /*
+ /**
* Specifies that the device will apply a color transform even when
* either the client or the device has chosen that all layers should
* be composed by the client. This will prevent the client from
@@ -46,7 +46,7 @@
SKIP_CLIENT_COLOR_TRANSFORM = 2,
};
- /*
+ /**
* Provides a list of supported capabilities (as described in the
* definition of Capability above). This list must not change after
* initialization.
@@ -58,7 +58,7 @@
@callflow(next="*")
getCapabilities() generates (vec<Capability> capabilities);
- /*
+ /**
* Retrieves implementation-defined debug information, which will be
* displayed during, for example, `dumpsys SurfaceFlinger`.
*
@@ -69,7 +69,7 @@
@callflow(next="*")
dumpDebugInfo() generates (string debugInfo);
- /*
+ /**
* Creates a client of the composer. All resources created by the client
* are owned by the client and are only visible to the client.
*
diff --git a/graphics/composer/2.1/IComposerCallback.hal b/graphics/composer/2.1/IComposerCallback.hal
index 541d7eb..ab74c30 100644
--- a/graphics/composer/2.1/IComposerCallback.hal
+++ b/graphics/composer/2.1/IComposerCallback.hal
@@ -20,13 +20,13 @@
enum Connection : int32_t {
INVALID = 0,
- /* The display has been connected */
+ /** The display has been connected */
CONNECTED = 1,
- /* The display has been disconnected */
+ /** The display has been disconnected */
DISCONNECTED = 2,
};
- /*
+ /**
* Notifies the client that the given display has either been connected or
* disconnected. Every active display (even a built-in physical display)
* must trigger at least one hotplug notification, even if it only occurs
@@ -47,7 +47,7 @@
@callflow(next="*")
onHotplug(Display display, Connection connected);
- /*
+ /**
* Notifies the client to trigger a screen refresh. This forces all layer
* state for this display to be resent, and the display to be validated
* and presented, even if there have been no changes.
@@ -61,7 +61,7 @@
@callflow(next="*")
oneway onRefresh(Display display);
- /*
+ /**
* Notifies the client that a vsync event has occurred. This callback must
* only be triggered when vsync is enabled for this display (through
* setVsyncEnabled).
diff --git a/graphics/composer/2.1/IComposerClient.hal b/graphics/composer/2.1/IComposerClient.hal
index 107ac5e..85572d4 100644
--- a/graphics/composer/2.1/IComposerClient.hal
+++ b/graphics/composer/2.1/IComposerClient.hal
@@ -20,18 +20,18 @@
import IComposerCallback;
interface IComposerClient {
- /* Display attributes queryable through getDisplayAttribute. */
+ /** Display attributes queryable through getDisplayAttribute. */
enum Attribute : int32_t {
INVALID = 0,
- /* Dimensions in pixels */
+ /** Dimensions in pixels */
WIDTH = 1,
HEIGHT = 2,
- /* Vsync period in nanoseconds */
+ /** Vsync period in nanoseconds */
VSYNC_PERIOD = 3,
- /*
+ /**
* Dots per thousand inches (DPI * 1000). Scaling by 1000 allows these
* numbers to be stored in an int32_t without losing too much
* precision. If the DPI for a configuration is unavailable or is
@@ -41,15 +41,15 @@
DPI_Y = 5,
};
- /* Display requests returned by getDisplayRequests. */
+ /** Display requests returned by getDisplayRequests. */
enum DisplayRequest : uint32_t {
- /*
+ /**
* Instructs the client to provide a new client target buffer, even if
* no layers are marked for client composition.
*/
FLIP_CLIENT_TARGET = 1 << 0,
- /*
+ /**
* Instructs the client to write the result of client composition
* directly into the virtual display output buffer. If any of the
* layers are not marked as Composition::CLIENT or the given display
@@ -58,9 +58,9 @@
WRITE_CLIENT_TARGET_TO_OUTPUT = 1 << 1,
};
- /* Layer requests returned from getDisplayRequests. */
+ /** Layer requests returned from getDisplayRequests. */
enum LayerRequest : uint32_t {
- /*
+ /**
* The client must clear its target with transparent pixels where
* this layer would be. The client may ignore this request if the
* layer must be blended.
@@ -68,24 +68,24 @@
CLEAR_CLIENT_TARGET = 1 << 0,
};
- /* Power modes for use with setPowerMode. */
+ /** Power modes for use with setPowerMode. */
enum PowerMode : int32_t {
- /* The display is fully off (blanked). */
+ /** The display is fully off (blanked). */
OFF = 0,
- /*
+ /**
* These are optional low power modes. getDozeSupport may be called to
* determine whether a given display supports these modes.
*/
- /*
+ /**
* The display is turned on and configured in a low power state that
* is suitable for presenting ambient information to the user,
* possibly with lower fidelity than ON, but with greater efficiency.
*/
DOZE = 1,
- /*
+ /**
* The display is configured as in DOZE but may stop applying display
* updates from the client. This is effectively a hint to the device
* that drawing to the display has been suspended and that the the
@@ -100,40 +100,40 @@
*/
DOZE_SUSPEND = 3,
- /* The display is fully on. */
+ /** The display is fully on. */
ON = 2,
};
- /* Vsync values passed to setVsyncEnabled. */
+ /** Vsync values passed to setVsyncEnabled. */
enum Vsync : int32_t {
INVALID = 0,
- /* Enable vsync. */
+ /** Enable vsync. */
ENABLE = 1,
- /* Disable vsync. */
+ /** Disable vsync. */
DISABLE = 2,
};
- /* Blend modes, settable per layer. */
+ /** Blend modes, settable per layer. */
enum BlendMode : int32_t {
INVALID = 0,
- /* colorOut = colorSrc */
+ /** colorOut = colorSrc */
NONE = 1,
- /* colorOut = colorSrc + colorDst * (1 - alphaSrc) */
+ /** colorOut = colorSrc + colorDst * (1 - alphaSrc) */
PREMULTIPLIED = 2,
- /* colorOut = colorSrc * alphaSrc + colorDst * (1 - alphaSrc) */
+ /** colorOut = colorSrc * alphaSrc + colorDst * (1 - alphaSrc) */
COVERAGE = 3,
};
- /* Possible composition types for a given layer. */
+ /** Possible composition types for a given layer. */
enum Composition : int32_t {
INVALID = 0,
- /*
+ /**
* The client must composite this layer into the client target buffer
* (provided to the device through setClientTarget).
*
@@ -142,7 +142,7 @@
*/
CLIENT = 1,
- /*
+ /**
* The device must handle the composition of this layer through a
* hardware overlay or other similar means.
*
@@ -151,7 +151,7 @@
*/
DEVICE = 2,
- /*
+ /**
* The device must render this layer using the color set through
* setLayerColor. If this functionality is not supported on a layer
* that the client sets to SOLID_COLOR, the device must request that
@@ -163,7 +163,7 @@
*/
SOLID_COLOR = 3,
- /*
+ /**
* Similar to DEVICE, but the position of this layer may also be set
* asynchronously through setCursorPosition. If this functionality is
* not supported on a layer that the client sets to CURSOR, the device
@@ -177,7 +177,7 @@
*/
CURSOR = 4,
- /*
+ /**
* The device must handle the composition of this layer, as well as
* its buffer updates and content synchronization. Only supported on
* devices which provide Capability::SIDEBAND_STREAM.
@@ -189,26 +189,26 @@
SIDEBAND = 5,
};
- /* Display types returned by getDisplayType. */
+ /** Display types returned by getDisplayType. */
enum DisplayType : int32_t {
INVALID = 0,
- /*
+ /**
* All physical displays, including both internal displays and
* hotpluggable external displays.
*/
PHYSICAL = 1,
- /* Virtual displays created by createVirtualDisplay. */
+ /** Virtual displays created by createVirtualDisplay. */
VIRTUAL = 2,
};
- /* Special index values (always negative) for command queue commands. */
+ /** Special index values (always negative) for command queue commands. */
enum HandleIndex : int32_t {
- /* No handle */
+ /** No handle */
EMPTY = -1,
- /* Use cached handle */
+ /** Use cached handle */
CACHED = -2,
};
@@ -233,7 +233,7 @@
uint8_t a;
};
- /*
+ /**
* Provides a IComposerCallback object for the device to call.
*
* This function must be called only once.
@@ -244,7 +244,7 @@
@callflow(next="*")
registerCallback(IComposerCallback callback);
- /*
+ /**
* Returns the maximum number of virtual displays supported by this device
* (which may be 0). The client must not attempt to create more than this
* many virtual displays on this device. This number must not change for
@@ -255,7 +255,7 @@
@callflow(next="*")
getMaxVirtualDisplayCount() generates (uint32_t count);
- /*
+ /**
* Creates a new virtual display with the given width and height. The
* format passed into this function is the default format requested by the
* consumer of the virtual display output buffers.
@@ -286,7 +286,7 @@
Display display,
PixelFormat format);
- /*
+ /**
* Destroys a virtual display. After this call all resources consumed by
* this display may be freed by the device and any operations performed on
* this display must fail.
@@ -300,7 +300,7 @@
@callflow(next="*")
destroyVirtualDisplay(Display display) generates (Error error);
- /*
+ /**
* Creates a new layer on the given display.
*
* @param display is the display on which to create the layer.
@@ -317,7 +317,7 @@
generates (Error error,
Layer layer);
- /*
+ /**
* Destroys the given layer.
*
* @param display is the display on which the layer was created.
@@ -329,7 +329,7 @@
@callflow(next="*")
destroyLayer(Display display, Layer layer) generates (Error error);
- /*
+ /**
* Retrieves which display configuration is currently active.
*
* If no display configuration is currently active, this function must
@@ -346,7 +346,7 @@
@callflow(next="*")
getActiveConfig(Display display) generates (Error error, Config config);
- /*
+ /**
* Returns whether a client target with the given properties can be
* handled by the device.
*
@@ -373,7 +373,7 @@
Dataspace dataspace)
generates (Error error);
- /*
+ /**
* Returns the color modes supported on this display.
*
* All devices must support at least ColorMode::NATIVE.
@@ -388,7 +388,7 @@
generates (Error error,
vec<ColorMode> modes);
- /*
+ /**
* Returns a display attribute value for a particular display
* configuration.
*
@@ -410,7 +410,7 @@
generates (Error error,
int32_t value);
- /*
+ /**
* Returns handles for all of the valid display configurations on this
* display.
*
@@ -424,7 +424,7 @@
generates (Error error,
vec<Config> configs);
- /*
+ /**
* Returns a human-readable version of the display's name.
*
* @return error is NONE upon success. Otherwise,
@@ -434,7 +434,7 @@
@callflow(next="*")
getDisplayName(Display display) generates (Error error, string name);
- /*
+ /**
* Returns whether the given display is a physical or virtual display.
*
* @param display is the display to query.
@@ -445,7 +445,7 @@
@callflow(next="*")
getDisplayType(Display display) generates (Error error, DisplayType type);
- /*
+ /**
* Returns whether the given display supports PowerMode::DOZE and
* PowerMode::DOZE_SUSPEND. DOZE_SUSPEND may not provide any benefit over
* DOZE (see the definition of PowerMode for more information), but if
@@ -460,7 +460,7 @@
@callflow(next="*")
getDozeSupport(Display display) generates (Error error, bool support);
- /*
+ /**
* Returns the high dynamic range (HDR) capabilities of the given display,
* which are invariant with regard to the active configuration.
*
@@ -486,7 +486,7 @@
float maxAverageLuminance,
float minLuminance);
- /*
+ /**
* Set the number of client target slots to be reserved.
*
* @param display is the display to which the slots are reserved.
@@ -500,7 +500,7 @@
uint32_t clientTargetSlotCount)
generates (Error error);
- /*
+ /**
* Sets the active configuration for this display. Upon returning, the
* given display configuration must be active and remain so until either
* this function is called again or the display is disconnected.
@@ -515,7 +515,7 @@
@callflow(next="*")
setActiveConfig(Display display, Config config) generates (Error error);
- /*
+ /**
* Sets the color mode of the given display.
*
* Upon returning from this function, the color mode change must have
@@ -534,7 +534,7 @@
@callflow(next="*")
setColorMode(Display display, ColorMode mode) generates (Error error);
- /*
+ /**
* Sets the power mode of the given display. The transition must be
* complete when this function returns. It is valid to call this function
* multiple times with the same power mode.
@@ -553,7 +553,7 @@
@callflow(next="*")
setPowerMode(Display display, PowerMode mode) generates (Error error);
- /*
+ /**
* Enables or disables the vsync signal for the given display. Virtual
* displays never generate vsync callbacks, and any attempt to enable
* vsync for a virtual display though this function must succeed and have
@@ -568,7 +568,7 @@
@callflow(next="*")
setVsyncEnabled(Display display, Vsync enabled) generates (Error error);
- /*
+ /**
* Sets the input command message queue.
*
* @param descriptor is the descriptor of the input command message queue.
@@ -579,7 +579,7 @@
setInputCommandQueue(fmq_sync<uint32_t> descriptor)
generates (Error error);
- /*
+ /**
* Gets the output command message queue.
*
* This function must only be called inside executeCommands closure.
@@ -593,7 +593,7 @@
generates (Error error,
fmq_sync<uint32_t> descriptor);
- /*
+ /**
* Executes commands from the input command message queue. Return values
* generated by the input commands are written to the output command
* message queue in the form of value commands.
@@ -620,7 +620,7 @@
uint32_t outLength,
vec<handle> outHandles);
- /*
+ /**
* SELECT_DISPLAY has this pseudo prototype
*
* selectDisplay(Display display);
@@ -1099,18 +1099,18 @@
OPCODE_SHIFT = 16,
OPCODE_MASK = 0xffff << OPCODE_SHIFT,
- /* special commands */
+ /** special commands */
SELECT_DISPLAY = 0x000 << OPCODE_SHIFT,
SELECT_LAYER = 0x001 << OPCODE_SHIFT,
- /* value commands (for return values) */
+ /** value commands (for return values) */
SET_ERROR = 0x100 << OPCODE_SHIFT,
SET_CHANGED_COMPOSITION_TYPES = 0x101 << OPCODE_SHIFT,
SET_DISPLAY_REQUESTS = 0x102 << OPCODE_SHIFT,
SET_PRESENT_FENCE = 0x103 << OPCODE_SHIFT,
SET_RELEASE_FENCES = 0x104 << OPCODE_SHIFT,
- /* display commands */
+ /** display commands */
SET_COLOR_TRANSFORM = 0x200 << OPCODE_SHIFT,
SET_CLIENT_TARGET = 0x201 << OPCODE_SHIFT,
SET_OUTPUT_BUFFER = 0x202 << OPCODE_SHIFT,
@@ -1118,12 +1118,12 @@
ACCEPT_DISPLAY_CHANGES = 0x204 << OPCODE_SHIFT,
PRESENT_DISPLAY = 0x205 << OPCODE_SHIFT,
- /* layer commands (VALIDATE_DISPLAY not required) */
+ /** layer commands (VALIDATE_DISPLAY not required) */
SET_LAYER_CURSOR_POSITION = 0x300 << OPCODE_SHIFT,
SET_LAYER_BUFFER = 0x301 << OPCODE_SHIFT,
SET_LAYER_SURFACE_DAMAGE = 0x302 << OPCODE_SHIFT,
- /* layer state commands (VALIDATE_DISPLAY required) */
+ /** layer state commands (VALIDATE_DISPLAY required) */
SET_LAYER_BLEND_MODE = 0x400 << OPCODE_SHIFT,
SET_LAYER_COLOR = 0x401 << OPCODE_SHIFT,
SET_LAYER_COMPOSITION_TYPE = 0x402 << OPCODE_SHIFT,
@@ -1136,7 +1136,7 @@
SET_LAYER_VISIBLE_REGION = 0x409 << OPCODE_SHIFT,
SET_LAYER_Z_ORDER = 0x40a << OPCODE_SHIFT,
- /* 0x800 - 0xfff are reserved for vendor extensions */
- /* 0x1000 - 0xffff are reserved */
+ /** 0x800 - 0xfff are reserved for vendor extensions */
+ /** 0x1000 - 0xffff are reserved */
};
};
diff --git a/graphics/composer/2.1/types.hal b/graphics/composer/2.1/types.hal
index e54031e..9f0dd8b 100644
--- a/graphics/composer/2.1/types.hal
+++ b/graphics/composer/2.1/types.hal
@@ -16,17 +16,17 @@
package android.hardware.graphics.composer@2.1;
-/* Return codes from all functions. */
+/** Return codes from all functions. */
enum Error : int32_t {
- NONE = 0, /* no error */
- BAD_CONFIG = 1, /* invalid Config */
- BAD_DISPLAY = 2, /* invalid Display */
- BAD_LAYER = 3, /* invalid Layer */
- BAD_PARAMETER = 4, /* invalid width, height, etc. */
- /* 5 is reserved */
- NO_RESOURCES = 6, /* temporary failure due to resource contention */
- NOT_VALIDATED = 7, /* validateDisplay has not been called */
- UNSUPPORTED = 8, /* permanent failure */
+ NONE = 0, /** no error */
+ BAD_CONFIG = 1, /** invalid Config */
+ BAD_DISPLAY = 2, /** invalid Display */
+ BAD_LAYER = 3, /** invalid Layer */
+ BAD_PARAMETER = 4, /** invalid width, height, etc. */
+ /** 5 is reserved */
+ NO_RESOURCES = 6, /** temporary failure due to resource contention */
+ NOT_VALIDATED = 7, /** validateDisplay has not been called */
+ UNSUPPORTED = 8, /** permanent failure */
};
typedef uint32_t Config;
diff --git a/graphics/mapper/2.0/IMapper.hal b/graphics/mapper/2.0/IMapper.hal
index 21a6dfa..573dcd0 100644
--- a/graphics/mapper/2.0/IMapper.hal
+++ b/graphics/mapper/2.0/IMapper.hal
@@ -27,7 +27,7 @@
int32_t height;
};
- /*
+ /**
* Adds a reference to the given buffer handle.
*
* A buffer handle received from a remote process or exported by
@@ -49,7 +49,7 @@
@callflow(next="*")
retain(handle bufferHandle) generates (Error error);
- /*
+ /**
* Removes a reference from the given buffer buffer.
*
* If no references remain, the buffer handle must be freed with
@@ -65,7 +65,7 @@
@exit
release(handle bufferHandle) generates (Error error);
- /*
+ /**
* Gets the width and height of the buffer in pixels.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -82,7 +82,7 @@
uint32_t width,
uint32_t height);
- /*
+ /**
* Gets the format of the buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -97,7 +97,7 @@
generates (Error error,
PixelFormat format);
- /*
+ /**
* Gets the number of layers of the buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -112,7 +112,7 @@
generates (Error error,
uint32_t layerCount);
- /*
+ /**
* Gets the producer usage flags which were used to allocate this buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -128,7 +128,7 @@
generates (Error error,
uint64_t usageMask);
- /*
+ /**
* Gets the consumer usage flags which were used to allocate this buffer.
*
* See IAllocator::BufferDescriptorInfo for more information.
@@ -144,7 +144,7 @@
generates (Error error,
uint64_t usageMask);
- /*
+ /**
* Gets a value that uniquely identifies the backing store of the given
* buffer.
*
@@ -165,7 +165,7 @@
generates (Error error,
BackingStore store);
- /*
+ /**
* Gets the stride of the buffer in pixels.
*
* The stride is the offset in pixel-sized elements between the same
@@ -185,7 +185,7 @@
generates (Error error,
uint32_t stride);
- /*
+ /**
* Locks the given buffer for the specified CPU usage.
*
* Exactly one of producerUsageMask and consumerUsageMask must be 0. The
@@ -247,7 +247,7 @@
generates (Error error,
pointer data);
- /*
+ /**
* This is largely the same as lock(), except that instead of returning a
* pointer directly to the buffer data, it returns an FlexLayout struct
* describing how to access the data planes.
@@ -296,7 +296,7 @@
generates (Error error,
FlexLayout layout);
- /*
+ /**
* This function indicates to the device that the client will be done with
* the buffer when releaseFence signals.
*
diff --git a/graphics/mapper/2.0/types.hal b/graphics/mapper/2.0/types.hal
index aa33141..2946e85 100644
--- a/graphics/mapper/2.0/types.hal
+++ b/graphics/mapper/2.0/types.hal
@@ -16,7 +16,7 @@
package android.hardware.graphics.mapper@2.0;
-/*
+/**
* Structures for describing flexible YUVA/RGBA formats for consumption by
* applications. Such flexible formats contain a plane for each component (e.g.
* red, green, blue), where each plane is laid out in a grid-like pattern
@@ -49,19 +49,19 @@
*/
enum FlexComponent : int32_t {
- Y = 1 << 0, /* luma */
- CB = 1 << 1, /* chroma blue */
- CR = 1 << 2, /* chroma red */
+ Y = 1 << 0, /** luma */
+ CB = 1 << 1, /** chroma blue */
+ CR = 1 << 2, /** chroma red */
- R = 1 << 10, /* red */
- G = 1 << 11, /* green */
- B = 1 << 12, /* blue */
+ R = 1 << 10, /** red */
+ G = 1 << 11, /** green */
+ B = 1 << 12, /** blue */
- A = 1 << 30, /* alpha */
+ A = 1 << 30, /** alpha */
};
enum FlexFormat : int32_t {
- /* not a flexible format */
+ /** not a flexible format */
INVALID = 0x0,
Y = FlexComponent:Y,
@@ -73,38 +73,38 @@
};
struct FlexPlane {
- /* Pointer to the first byte of the top-left pixel of the plane. */
+ /** Pointer to the first byte of the top-left pixel of the plane. */
pointer topLeft;
FlexComponent component;
- /*
+ /**
* Bits allocated for the component in each pixel. Must be a positive
* multiple of 8.
*/
int32_t bitsPerComponent;
- /*
+ /**
* Number of the most significant bits used in the format for this
* component. Must be between 1 and bitsPerComponent, inclusive.
*/
int32_t bitsUsed;
- /* Horizontal increment. */
+ /** Horizontal increment. */
int32_t hIncrement;
- /* Vertical increment. */
+ /** Vertical increment. */
int32_t vIncrement;
- /* Horizontal subsampling. Must be a positive power of 2. */
+ /** Horizontal subsampling. Must be a positive power of 2. */
int32_t hSubsampling;
- /* Vertical subsampling. Must be a positive power of 2. */
+ /** Vertical subsampling. Must be a positive power of 2. */
int32_t vSubsampling;
};
struct FlexLayout {
- /* The kind of flexible format. */
+ /** The kind of flexible format. */
FlexFormat format;
- /*
+ /**
* A plane for each component; ordered in increasing component value
* order. E.g. FlexFormat::RGBA maps 0 -> R, 1 -> G, etc. Can have size 0
* for FlexFormat::INVALID.
@@ -112,5 +112,5 @@
vec<FlexPlane> planes;
};
-/* Backing store ID of a buffer. See IMapper::getBackingStore. */
+/** Backing store ID of a buffer. See IMapper::getBackingStore. */
typedef uint64_t BackingStore;