|
5 | 5 | * Review Manager: TBD
|
6 | 6 | * Status: **Awaiting review**
|
7 | 7 | * Implementation: [swiftlang/swift-testing#1245](https://github.com/swiftlang/swift-testing/pull/1245), [swiftlang/swift-testing#1254](https://github.com/swiftlang/swift-testing/pull/1254), _et al_.
|
8 |
| -* Review: ([pitch](https://forums.swift.org/...)) |
| 8 | +* Review: ([pitch](https://forums.swift.org/t/pitch-image-attachments-in-swift-testing-windows/81871)) |
9 | 9 |
|
10 | 10 | ## Introduction
|
11 | 11 |
|
@@ -233,28 +233,31 @@ Conveniences over those COM classes' `CLSID` values are provided:
|
233 | 233 |
|
234 | 234 | ```swift
|
235 | 235 | extension AttachableImageFormat {
|
236 |
| - /// The `CLSID` value corresponding to the WIC image encoder for this image |
237 |
| - /// format. |
238 |
| - public var clsid: CLSID { get } |
| 236 | + /// The `CLSID` value of the Windows Imaging Component (WIC) encoder class |
| 237 | + /// that corresponds to this image format. |
| 238 | + /// |
| 239 | + /// For example, if this image format equals ``png``, the value of this |
| 240 | + /// property equals [`CLSID_WICPngEncoder`](https://learn.microsoft.com/en-us/windows/win32/wic/-wic-guids-clsids#wic-guids-and-clsids). |
| 241 | + public var encoderCLSID: CLSID { get } |
239 | 242 |
|
240 |
| - /// Construct an instance of this type with the given `CLSID` value and |
241 |
| - /// encoding quality. |
| 243 | + /// Construct an instance of this type with the `CLSID` value of a Windows |
| 244 | + /// Imaging Component (WIC) encoder class and the desired encoding quality. |
242 | 245 | ///
|
243 | 246 | /// - Parameters:
|
244 |
| - /// - clsid: The `CLSID` value corresponding to a WIC image encoder to use |
245 |
| - /// when encoding images. |
| 247 | + /// - encoderCLSID: The `CLSID` value of the Windows Imaging Component |
| 248 | + /// encoder class to use when encoding images. |
246 | 249 | /// - encodingQuality: The encoding quality to use when encoding images. For
|
247 | 250 | /// the lowest supported quality, pass `0.0`. For the highest supported
|
248 | 251 | /// quality, pass `1.0`.
|
249 | 252 | ///
|
250 | 253 | /// If the target image encoder does not support variable-quality encoding,
|
251 | 254 | /// the value of the `encodingQuality` argument is ignored.
|
252 | 255 | ///
|
253 |
| - /// If `clsid` does not represent an image encoder type supported by WIC, the |
254 |
| - /// result is undefined. For a list of image encoders supported by WIC, see |
255 |
| - /// the documentation for the [`IWICBitmapEncoder`](https://learn.microsoft.com/en-us/windows/win32/api/wincodec/nn-wincodec-iwicbitmapencoder) |
| 256 | + /// If `clsid` does not represent an image encoder class supported by WIC, the |
| 257 | + /// result is undefined. For a list of image encoder classes supported by WIC, |
| 258 | + /// see the documentation for the [`IWICBitmapEncoder`](https://learn.microsoft.com/en-us/windows/win32/api/wincodec/nn-wincodec-iwicbitmapencoder) |
256 | 259 | /// class.
|
257 |
| - public init(_ clsid: CLSID, encodingQuality: Float = 1.0) |
| 260 | + public init(encoderCLSID: CLSID, encodingQuality: Float = 1.0) |
258 | 261 | }
|
259 | 262 | ```
|
260 | 263 |
|
|
0 commit comments