Update PhotonPipelineResult.h

PhotonVision · Sep 30, 2023 · 6523add · 6523add
1 parent f65f1c9
commit 6523add
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/photon-lib/src/main/native/include/photonlib/PhotonPipelineResult.h b/photon-lib/src/main/native/include/photonlib/PhotonPipelineResult.h
@@ -88,6 +88,11 @@ class PhotonPipelineResult {
    */
   units::second_t GetTimestamp() const { return timestamp; }
 
+  /**
+   * Return the latest mulit-target result, as calculated on your coprocessor.
+   * Be sure to check getMultiTagResult().estimatedPose.isValid before using the
+   * pose estimate!
+   */
   const MultiTargetPnpResult& MultiTagResult() const { return m_pnpResults; }
 
   /**