Hand apply a484114b80f21f2f786b6142ad950f5295249673 from master;
[dcpomatic.git] / src / lib / subtitle_decoder.cc
index e1485e2..9b2aa8a 100644 (file)
@@ -34,6 +34,9 @@ SubtitleDecoder::SubtitleDecoder (shared_ptr<const SubtitleContent> c)
 
 /** Called by subclasses when an image subtitle is ready.
  *  Image may be 0 to say that there is no current subtitle.
+ *  @param rect Area expressed as a fraction of the video frame that this subtitle
+ *  is for (e.g. a width of 0.5 means the width of the subtitle is half the width
+ *  of the video frame)
  */
 void
 SubtitleDecoder::image_subtitle (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)