Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6a7ba9ad authored by Jiwen 'Steve' Cai's avatar Jiwen 'Steve' Cai Committed by Jiwen Cai
Browse files

Update libdvrtracking doc 

Explicitly states the ownership of the DvrWriteBufferQueue handle.

Bug: 109710161
Test: header only, build system.
Change-Id: Ida6b8d8b99a62cfa8de4d348ce0edc243a296baa
(cherry picked from commit 5e520122df1d93f12b449aa2ed127dc85d9fdf4b)
parent c1ab9e8c

libs/vr/libdvr/include/dvr/dvr_tracking.h

+4 −1
Original line number Diff line number Diff line
@@ -59,7 +59,10 @@ void dvrTrackingCameraDestroy(DvrTrackingCamera* camera); 
//     populate the buffer into. The queue must be empty and the camera stack

//     will request buffer allocation with proper buffer dimension, format, and

//     usage. Note that the write queue must be created with user_metadata_size

//     set to sizeof(DvrTrackingBufferMetadata).

//     set to sizeof(DvrTrackingBufferMetadata). On success, the write_queue

//     handle will become invalid and the ownership of the queue handle will be

//     transferred into the camera; otherwise, the write_queue handle will keep

//     untouched and the caller still has the ownership.

// @return Zero on success, or negative error code.

int dvrTrackingCameraStart(DvrTrackingCamera* camera,

                           DvrWriteBufferQueue* write_queue);