Evolution-x/hardware_interfaces
1
0
Fork 0
mirror of https://github.com/Evolution-X/hardware_interfaces synced 2026-02-01 11:36:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "composer3: fix documentation to match aidl style"

Browse Source
This commit is contained in:
TreeHugger Robot
2021-12-14 01:43:16 +00:00
committed by Android (Google) Code Review
parent d394ed451c a80531fdc0
commit 3e63928814
10 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
graphics/composer/aidl/android/hardware/graphics/composer3/ColorTransformPayload.aidl
View File

@@ -27,7 +27,7 @@ parcelable ColorTransformPayload {
/**
* Hint value which may be used instead of the given matrix unless it
* is ColorTransform::ARBITRARY.
* is ColorTransform.ARBITRARY.
*/
ColorTransform hint;
}

2
graphics/composer/aidl/android/hardware/graphics/composer3/Composition.aidl
View File

@@ -66,7 +66,7 @@ enum Composition {
/**
* 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.
* devices which provide Capability.SIDEBAND_STREAM.
*
* Upon validateDisplay, the device may request a change from this
* type to either DEVICE or CLIENT, but it is unlikely that content

10
graphics/composer/aidl/android/hardware/graphics/composer3/DisplayCapability.aidl
View File

@@ -41,15 +41,15 @@ enum DisplayCapability {
*/
SKIP_CLIENT_COLOR_TRANSFORM = 1,
/**
* Indicates that the display supports PowerMode::DOZE and
* potentially PowerMode::DOZE_SUSPEND if DisplayCapability.SUSPEND is also
* Indicates that the display supports PowerMode.DOZE and
* potentially PowerMode.DOZE_SUSPEND if DisplayCapability.SUSPEND is also
* supported. DOZE_SUSPEND may not provide any benefit
* over DOZE (see the definition of PowerMode for more information),
* but if both DOZE and DOZE_SUSPEND are no different from
* PowerMode::ON, the device must not claim support.
* PowerMode.ON, the device must not claim support.
* Must be returned by getDisplayCapabilities when getDozeSupport
* indicates the display supports PowerMode::DOZE and
* PowerMode::DOZE_SUSPEND.
* indicates the display supports PowerMode.DOZE and
* PowerMode.DOZE_SUSPEND.
*/
DOZE = 2,
/**

10
graphics/composer/aidl/android/hardware/graphics/composer3/DisplayCommand.aidl
View File

@@ -38,7 +38,7 @@ parcelable DisplayCommand {
/**
* Sets a color transform which will be applied after composition.
*
* If hint is not ColorTransform::ARBITRARY, then the device may use the
* If hint is not ColorTransform.ARBITRARY, then the device may use the
* hint to apply the desired color transform instead of using the color
* matrix directly.
*
@@ -46,7 +46,7 @@ parcelable DisplayCommand {
* apply the desired color transform, it must force all layers to client
* composition during VALIDATE_DISPLAY.
*
* If IComposer::Capability::SKIP_CLIENT_COLOR_TRANSFORM is present, then
* If Capability.SKIP_CLIENT_COLOR_TRANSFORM is present, then
* the client must never apply the color transform during client
* composition, even if all layers are being composed by the client.
*
@@ -74,9 +74,9 @@ parcelable DisplayCommand {
/**
* Sets the buffer handle which will receive the output of client
* composition. Layers marked as Composition::CLIENT must be composited
* composition. Layers marked as Composition.CLIENT must be composited
* into this buffer prior to the call to PRESENT_DISPLAY, and layers not
* marked as Composition::CLIENT must be composited with this buffer by
* marked as Composition.CLIENT must be composited with this buffer by
* the device.
*
* The buffer handle provided may be empty if no layers are being
@@ -94,7 +94,7 @@ parcelable DisplayCommand {
* the description of SET_LAYER_SURFACE_DAMAGE.
*
* Will be called before PRESENT_DISPLAY if any of the layers are marked
* as Composition::CLIENT. If no layers are so marked, then it is not
* as Composition.CLIENT. If no layers are so marked, then it is not
* necessary to call this function. It is not necessary to call
* validateDisplay after changing the target through this function.
*/

2
graphics/composer/aidl/android/hardware/graphics/composer3/DisplayRequest.aidl
View File

@@ -27,7 +27,7 @@ parcelable DisplayRequest {
/**
* 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
* layers are not marked as Composition.CLIENT or the given display
* is not a virtual display, this request has no effect.
*/
const int WRITE_CLIENT_TARGET_TO_OUTPUT = 1 << 1;

2
graphics/composer/aidl/android/hardware/graphics/composer3/IComposer.aidl
View File

@@ -27,7 +27,7 @@ interface IComposer {
const int EX_NO_RESOURCES = 6;
/**
* Creates a v2.4 client of the composer. Supersedes @2.3::createClient.
* Creates a client of the composer.
*
* @return is the newly created client.
*

2
graphics/composer/aidl/android/hardware/graphics/composer3/IComposerCallback.aidl
View File

@@ -26,7 +26,7 @@ interface IComposerCallback {
* must trigger at least one hotplug notification, even if it only occurs
* immediately after callback registration.
*
* Displays which have been connected are assumed to be in PowerMode::OFF,
* Displays which have been connected are assumed to be in PowerMode.OFF,
* and the onVsync callback should not be called for a display until vsync
* has been enabled with setVsyncEnabled.
*

26
graphics/composer/aidl/android/hardware/graphics/composer3/IComposerClient.aidl
View File

@@ -185,7 +185,7 @@ interface IComposerClient {
/**
* Returns the color modes supported on this display.
*
* All devices must support at least ColorMode::NATIVE.
* All devices must support at least ColorMode.NATIVE.
*
* @param display is the display to query.
*
@@ -201,7 +201,7 @@ interface IComposerClient {
*
* When the layer dataspace is a legacy dataspace (see
* common@1.1::Dataspace) and the display render intent is
* RenderIntent::ENHANCE, the pixel values can go through an
* RenderIntent.ENHANCE, the pixel values can go through an
* implementation-defined saturation transform before being mapped to the
* current color mode colorimetrically.
*
@@ -409,8 +409,8 @@ interface IComposerClient {
*
* The width and height of this buffer must be those of the currently-active
* display configuration, and the usage flags must consist of the following:
* BufferUsage::CPU_READ | BufferUsage::GPU_TEXTURE |
* BufferUsage::COMPOSER_OUTPUT
* BufferUsage.CPU_READ | BufferUsage.GPU_TEXTURE |
* BufferUsage.COMPOSER_OUTPUT
*
* The format and dataspace provided must be sufficient such that if a
* correctly-configured buffer is passed into setReadbackBuffer, filled by
@@ -485,8 +485,8 @@ interface IComposerClient {
* Returns the render intents supported by the specified display and color
* mode.
*
* For SDR color modes, RenderIntent::COLORIMETRIC must be supported. For
* HDR color modes, RenderIntent::TONE_MAP_COLORIMETRIC must be supported.
* For SDR color modes, RenderIntent.COLORIMETRIC must be supported. For
* HDR color modes, RenderIntent.TONE_MAP_COLORIMETRIC must be supported.
*
* @param display is the display to query.
* @param mode is the color mode to query.
@@ -500,11 +500,11 @@ interface IComposerClient {
/**
* Provides a list of all the content types supported by this display (any of
* ContentType::{GRAPHICS, PHOTO, CINEMA, GAME}). This list must not change after
* ContentType.{GRAPHICS, PHOTO, CINEMA, GAME}). This list must not change after
* initialization.
*
* Content types are introduced in HDMI 1.4 and supporting them is optional. The
* ContentType::NONE is always supported and will not be returned by this method..
* ContentType.NONE is always supported and will not be returned by this method..
*
* @return out is a list of supported content types.
*
@@ -571,7 +571,7 @@ interface IComposerClient {
* be triggered.
*
* This function should only be called if the display reports support for
* DisplayCapability::AUTO_LOW_LATENCY_MODE from getDisplayCapabilities_2_4.
* DisplayCapability.AUTO_LOW_LATENCY_MODE from getDisplayCapabilities_2_4.
*
* @exception EX_BAD_DISPLAY when an invalid display handle was passed in.
* @exception EX_UNSUPPORTED when AUTO_LOW_LATENCY_MODE is not supported by the composer
@@ -595,8 +595,8 @@ interface IComposerClient {
* The color mode and render intent change must take effect on next
* presentDisplay.
*
* All devices must support at least ColorMode::NATIVE and
* RenderIntent::COLORIMETRIC, and displays are assumed to be in this mode
* All devices must support at least ColorMode.NATIVE and
* RenderIntent.COLORIMETRIC, and displays are assumed to be in this mode
* upon hotplug.
*
* @param display is the display to which the color mode is set.
@@ -682,8 +682,8 @@ interface IComposerClient {
* complete when this function returns. It is valid to call this function
* multiple times with the same power mode.
*
* All displays must support PowerMode::ON and PowerMode::OFF. Whether a
* display supports PowerMode::DOZE or PowerMode::DOZE_SUSPEND may be
* All displays must support PowerMode.ON and PowerMode.OFF. Whether a
* display supports PowerMode.DOZE or PowerMode.DOZE_SUSPEND may be
* queried using getDozeSupport.
*
* @param display is the display to which the power mode is set.

20
graphics/composer/aidl/android/hardware/graphics/composer3/LayerCommand.aidl
View File

@@ -45,7 +45,7 @@ parcelable LayerCommand {
/**
* Asynchronously sets the position of a cursor layer.
*
* Prior to validateDisplay, a layer may be marked as Composition::CURSOR.
* Prior to validateDisplay, a layer may be marked as Composition.CURSOR.
* If validation succeeds (i.e., the device does not request a composition
* change for that layer), then once a buffer has been set for the layer
* and it has been presented, its position may be set by this function at
@@ -73,8 +73,8 @@ parcelable LayerCommand {
* may be passed instead.
*
* This function must return NONE and have no other effect if called for a
* layer with a composition type of Composition::SOLID_COLOR (because it
* has no buffer) or Composition::SIDEBAND or Composition::CLIENT (because
* layer with a composition type of Composition.SOLID_COLOR (because it
* has no buffer) or Composition.SIDEBAND or Composition.CLIENT (because
* synchronization and buffer updates for these layers are handled
* elsewhere).
*/
@@ -109,14 +109,14 @@ parcelable LayerCommand {
/**
* Sets the color of the given layer. If the composition type of the layer
* is not Composition::SOLID_COLOR, this call must succeed and have no
* is not Composition.SOLID_COLOR, this call must succeed and have no
* other effect.
*/
@nullable Color color;
/**
* Sets the color of the given layer. If the composition type of the layer
* is not Composition::SOLID_COLOR, this call must succeed and have no
* is not Composition.SOLID_COLOR, this call must succeed and have no
* other effect.
*/
@nullable FloatColor floatColor;
@@ -149,20 +149,20 @@ parcelable LayerCommand {
* Sets an alpha value (a floating point value in the range [0.0, 1.0])
* which will be applied to the whole layer. It can be conceptualized as a
* preprocessing step which applies the following function:
* if (blendMode == BlendMode::PREMULTIPLIED)
* if (blendMode == BlendMode.PREMULTIPLIED)
* out.rgb = in.rgb * planeAlpha
* out.a = in.a * planeAlpha
*
* If the device does not support this operation on a layer which is
* marked Composition::DEVICE, it must request a composition type change
* to Composition::CLIENT upon the next validateDisplay call.
* marked Composition.DEVICE, it must request a composition type change
* to Composition.CLIENT upon the next validateDisplay call.
*
*/
@nullable PlaneAlpha planeAlpha;
/**
* Sets the sideband stream for this layer. If the composition type of the
* given layer is not Composition::SIDEBAND, this call must succeed and
* given layer is not Composition.SIDEBAND, this call must succeed and
* have no other effect.
*/
@nullable NativeHandle sidebandStream;
@@ -174,7 +174,7 @@ parcelable LayerCommand {
*
* If the device is not capable of supporting a true float source crop
* (i.e., it will truncate or round the floats to integers), it must set
* this layer to Composition::CLIENT when crop is non-integral for the
* this layer to Composition.CLIENT when crop is non-integral for the
* most accurate rendering.
*
* If the device cannot support float source crops, but still wants to

6
graphics/composer/aidl/android/hardware/graphics/composer3/RenderIntent.aidl
View File

@@ -25,8 +25,8 @@ package android.hardware.graphics.composer3;
* modes should not affect the mapping.
*
* RenderIntent overrides the render intents defined for individual color
* modes. It is ignored when the color mode is ColorMode::NATIVE, because
* ColorMode::NATIVE colors are already display colors.
* modes. It is ignored when the color mode is ColorMode.NATIVE, because
* ColorMode.NATIVE colors are already display colors.
*/
@VintfStability
@Backing(type="int")
@@ -36,7 +36,7 @@ enum RenderIntent {
* gamut are hard-clipped.
*
* This implies that the display must have been calibrated unless
* ColorMode::NATIVE is the only supported color mode.
* ColorMode.NATIVE is the only supported color mode.
*/
COLORIMETRIC = 0,
/**