Menu
▾
▴
[Gtk2hs-commit] (main branch): gstreamer: M.S.G.Core.Buffer documentation edits and additions
|
From: <du...@co...> - 2008-05-22 19:24:00
|
Sat May 17 19:53:27 EDT 2008 Peter Gavin <pg...@gm...>
* gstreamer: M.S.G.Core.Buffer documentation edits and additions
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 36
- -- | Buffers are the basic unit of data transfer in GStreamer. The
+ -- | 'Buffer's are the basic unit of data transfer in GStreamer. The
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 39
- -- supported, allowing a smaller region of a buffer to become its
- -- own buffer, with mechansims in place to ensure that neither
+ -- supported, allowing a smaller region of a 'Buffer' to become its
+ -- own 'Buffer', with mechansims in place to ensure that neither
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 105
--- | Get the flags set on this buffer.
+-- | Get the flags set on @buffer@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 107
- => bufferT
- -> [BufferFlags]
+ => bufferT -- ^ @buffer@ - a 'Buffer'
+ -> [BufferFlags] -- ^ the flags set on @buffer@
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 111
--- | Get the flags set on the current buffer.
+-- | Get the flags set on the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 113
- => MiniObjectT bufferT m [BufferFlags]
+ => MiniObjectT bufferT m [BufferFlags] -- ^ the flags set on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 116
--- | Set flags on the current buffer.
+-- | Set flags on the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 118
- => [BufferFlags]
+ => [BufferFlags] -- ^ @flags@ - the flags to set on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 122
--- | Unset flags on the current buffer.
+-- | Unset flags on the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 124
- => [BufferFlags]
+ => [BufferFlags] -- ^ @flags@ - the flags to unset on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 128
--- | Get the size of the buffer.
+-- | Get @buffer@'s size in bytes.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 130
- => bufferT
- -> Word
+ => bufferT -- ^ @buffer@ - a 'Buffer'
+ -> Word -- ^ the size of @buffer@ in bytes
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 143
--- | Get the size of the current buffer.
+-- | Get the size of the current 'Buffer' in bytes.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 145
- => MiniObjectT bufferT m Word
+ => MiniObjectT bufferT m Word -- ^ the size of the current 'Buffer' in bytes
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 150
--- | Make an O(n) copy of the buffer data.
+-- | Make an O(n) copy of the data stored in @buffer@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 152
- => bufferT
- -> BS.ByteString
+ => bufferT -- ^ @buffer@ - a 'Buffer'
+ -> BS.ByteString -- ^ the data stored in @buffer@
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 164
--- | Make an O(n) copy of the current buffer.
+-- | Make an O(n) copy of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 166
- => MiniObjectT bufferT m BS.ByteString
+ => MiniObjectT bufferT m BS.ByteString -- ^ the data stored in the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 177
--- | Store an O(n) copy of the provided data in the current buffer.
+-- | Store an O(n) copy of the provided data in the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 179
- => BS.ByteString
+ => BS.ByteString -- ^ @bs@ - the data to store in the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 196
--- be used once the buffer is returned.
+-- be used once the 'Buffer' is returned.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 198
- => MiniObjectT bufferT m (Ptr Word8)
+ => MiniObjectT bufferT m (Ptr Word8) -- ^ a pointer to the data stored in the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 238
--- | Get the timestamp for this buffer.
+-- | Get the timestamp on @buffer@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 240
- => bufferT
- -> Maybe ClockTime
+ => bufferT -- ^ @buffer@ - a 'Buffer'
+ -> Maybe ClockTime -- ^ the timestamp on @buffer@
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 245
--- | Get the timestamp of the current buffer.
+-- | Get the timestamp on the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 247
- => MiniObjectT bufferT m (Maybe ClockTime)
+ => MiniObjectT bufferT m (Maybe ClockTime) -- ^ the timestamp on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 251
--- | Set the timestamp of the current buffer.
+-- | Set the timestamp on the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 253
- => Maybe ClockTime
+ => Maybe ClockTime -- ^ @timestamp@ - the timestamp to set on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 258
--- | Get the duration of the buffer.
+-- | Get the duration of @buffer@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 260
- => bufferT
- -> Maybe ClockTime
+ => bufferT -- ^ @buffer@ - a 'Buffer'
+ -> Maybe ClockTime -- ^ the duration of @buffer@
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 265
--- | Get the duration of the current buffer.
+-- | Get the duration of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 267
- => MiniObjectT bufferT m (Maybe ClockTime)
+ => MiniObjectT bufferT m (Maybe ClockTime) -- ^ the duration of the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 271
--- | Set the duration of the current buffer.
+-- | Set the duration of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 273
- => Maybe ClockTime
+ => Maybe ClockTime -- ^ @duration@ - the duration to set on the current 'Buffer'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 278
--- | Get the caps of the buffer.
+-- | Get the 'Caps' of @buffer@.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 280
- => bufferT
- -> Maybe Caps
+ => bufferT -- ^ @buffer@ - a buffer
+ -> Maybe Caps -- ^ the 'Caps' of @buffer@ if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 287
--- | Get the caps of the current buffer.
+-- | Get the caps of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 289
- => MiniObjectT bufferT m (Maybe Caps)
+ => MiniObjectT bufferT m (Maybe Caps) -- ^ the 'Caps' of the current 'Buffer'
+ -- if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 297
--- | Set the caps of the current buffer.
+-- | Set the caps of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 299
- => Maybe Caps
+ => Maybe Caps -- ^ @caps@ - the 'Caps' to set on the current
+ -- 'Buffer', or 'Nothing' to unset them
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 310
--- | Get the offset of the buffer.
+-- | Get the start offset of the 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 312
- => bufferT
- -> Maybe Word64
+ => bufferT -- ^ @buffer@ - a buffer
+ -> Maybe Word64 -- ^ the start offset of @buffer@ if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 317
--- | Get the start offset of the current buffer.
+-- | Get the start offset of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 319
- => MiniObjectT bufferT m (Maybe Word64)
+ => MiniObjectT bufferT m (Maybe Word64) -- ^ the start offset of the current
+ -- 'Buffer' if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 324
--- | Set the start offset of the current buffer.
+-- | Set the start offset of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 326
- => Maybe Word64
+ => Maybe Word64 -- ^ @offset@ - the start offset to set on the current buffer
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 331
--- | Get the end offset of the buffer.
+-- | Get the end offset of the 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 333
- => bufferT
- -> Maybe Word64
+ => bufferT -- ^ @buffer@ - a buffer
+ -> Maybe Word64 -- ^ the end offset of @buffer@ if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 338
--- | Get the end offset of the current buffer.
+-- | Get the end offset of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 340
- => MiniObjectT bufferT m (Maybe Word64)
+ => MiniObjectT bufferT m (Maybe Word64) -- ^ the start offset of the current
+ -- 'Buffer' if set, otherwise 'Nothing'
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 345
--- | Set the end offset of the current buffer.
+-- | Set the end offset of the current 'Buffer'.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 347
- => Maybe Word64
+ => Maybe Word64 -- ^ @offset@ - the end offset to set on the current buffer
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 352
--- | Return 'True' if the buffer marks a discontinuity in a stream, or
+-- | Return 'True' if the 'Buffer' marks a discontinuity in a stream, or
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 356
- => bufferT
- -> Bool
+ => bufferT -- ^ @buffer@ - a buffer
+ -> Bool -- ^ 'True' if @buffer@ marks a discontinuity in a stream
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 361
--- | Return 'True' if the current buffer marks a discontinuity in a
+-- | Return 'True' if the current 'Buffer' marks a discontinuity in a
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 364
- => MiniObjectT bufferT m Bool
+ => MiniObjectT bufferT m Bool -- ^ 'True' if the current buffer marks a
+ -- discontinuity in a stream
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 369
--- | Create an empty buffer and mutate it according to the given
--- action. Once this function returns, the buffer is immutable.
+-- | Create an empty 'Buffer' and mutate it according to the given
+-- action. Once this function returns, the 'Buffer' is immutable.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 372
- => MiniObjectT Buffer m a -- ^ the mutating action
+ => MiniObjectT Buffer m a -- ^ @mutate@ - the mutating action
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 377
--- | Create and mutate a buffer of the given size.
+-- | Create and mutate a 'Buffer' of the given size.
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 379
- => Word -- ^ the size of the buffer to be created
- -> MiniObjectT Buffer m a -- ^ the mutating action
- -> m (Buffer, a) -- ^ the new buffer and the action's result
+ => Word -- ^ @size@ - the size of the 'Buffer' to be created
+ -> MiniObjectT Buffer m a -- ^ @mutate@ - the mutating action
+ -> m (Buffer, a) -- ^ the new 'Buffer' and the action's result
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 386
--- | Create a sub-buffer from an existing buffer with the given offset
+-- | Create a sub-buffer from an existing 'Buffer' with the given offset
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 394
- => bufferT -- ^ the parent buffer
- -> Word -- ^ the offset
- -> Word -- ^ the size
+ => bufferT -- ^ @parent@ - the parent buffer
+ -> Word -- ^ @offset@ - the offset
+ -> Word -- ^ @size@ - the size
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 408
- => bufferT1
- -> bufferT2
- -> Bool
+ => bufferT1 -- ^ @buffer1@ - the first buffer
+ -> bufferT2 -- ^ @buffer2@ - the second buffer
+ -> Bool -- ^ 'True' if the buffers are contiguous,
+ -- or 'False' if copying would be
+ -- required
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 418
--- | Create a new buffer that consists of a span across the given
+-- | Create a new 'Buffer' that consists of a span across the given
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 427
- => bufferT1 -- ^ the first buffer
- -> Word32 -- ^ the offset into the concatenated buffer
- -> bufferT2 -- ^ the second buffer
- -> Word32 -- ^ the length of the final buffer
+ => bufferT1 -- ^ @buffer1@ - the first buffer
+ -> Word32 -- ^ @offset@ - the offset into the concatenated buffer
+ -> bufferT2 -- ^ @buffer2@ - the second buffer
+ -> Word32 -- ^ @len@ - the length of the final buffer
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Buffer.chs.pp 444
- => bufferT1 -- ^ a buffer
- -> bufferT2 -- ^ a buffer
+ => bufferT1 -- ^ @buffer1@ - a buffer
+ -> bufferT2 -- ^ @buffer2@ - a buffer
|
