Skip to content

Commit 5ee2b53

Browse files
committed
Fixed documentation for roll.
Signed-off-by: Gonzalo Garramuño <[email protected]>
1 parent 1594ff1 commit 5ee2b53

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/opentimelineio/algo/editAlgorithm.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,17 @@ void ripple(
126126
ErrorStatus* error_status = nullptr);
127127

128128
//
129-
// Adjust a source_range without affecting any other items.
129+
// Any trim-like action results in adjacent items source_range being adjusted
130+
// to fit.
131+
// No new items are ever created.
132+
// Clamped to available media (if available)
133+
// Start time in parent of Item before input item will never change
134+
// End time in parent of Item after input item will never change
130135
//
131136
// | A | B | -> | A | B |
132137
// <--*
133138
//
134-
// item = Item to apply ripple to (usually a clip)
139+
// item = Item to apply roll to (usually a clip)
135140
// delta_in = RationalTime that the item's source_range().start_time()
136141
// will be adjusted by
137142
// delta_out = RationalTime that the item's

0 commit comments

Comments
 (0)