Skip to content

Commit 5f81aef

Browse files
committed
Add missing Javadoc for getFormatInfo
1 parent 9f81ad5 commit 5f81aef

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

src/main/java/io/github/doblon8/openpnp/capture/CaptureDevice.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,14 @@ private int getNumFormats(int deviceId) throws CaptureException {
7878
return result;
7979
}
8080

81+
/**
82+
* Get the format information from a device.
83+
*
84+
* @param deviceId the device id of the capture device.
85+
* @param formatId the format id of the capture format.
86+
* @return the format information of the capture format with the given id on the capture device with the given id.
87+
* @throws CaptureException if no device with the given id exists, or if no format with the given id exists on the device.
88+
*/
8189
private CaptureFormatInfo getFormatInfo(int deviceId, int formatId) throws CaptureException {
8290
try (Arena arena = Arena.ofConfined()) {
8391
MemorySegment formatInfoSegment = CapFormatInfo.allocate(arena);

0 commit comments

Comments
 (0)