From 62cf6348cd9b5b8b7cb1662ca1b4684f9f8e7b59 Mon Sep 17 00:00:00 2001 From: Matthew Leibowitz Date: Tue, 7 Mar 2017 07:56:10 -0300 Subject: [PATCH] Added some more docs --- docs/en/SkiaSharp/SKCodec.xml | 4 +- docs/en/SkiaSharp/SKFrontBufferedStream.xml | 349 ++++++++++++++++++++ docs/en/SkiaSharp/SKImageInfo.xml | 76 ++++- docs/en/SkiaSharp/SKPMColor.xml | 2 +- docs/en/index.xml | 1 + 5 files changed, 424 insertions(+), 8 deletions(-) create mode 100644 docs/en/SkiaSharp/SKFrontBufferedStream.xml diff --git a/docs/en/SkiaSharp/SKCodec.xml b/docs/en/SkiaSharp/SKCodec.xml index a315c94cd..813f51c88 100644 --- a/docs/en/SkiaSharp/SKCodec.xml +++ b/docs/en/SkiaSharp/SKCodec.xml @@ -16,9 +16,7 @@ An abstraction layer directly on top of an image codec. - - - + diff --git a/docs/en/SkiaSharp/SKFrontBufferedStream.xml b/docs/en/SkiaSharp/SKFrontBufferedStream.xml new file mode 100644 index 000000000..c1545f100 --- /dev/null +++ b/docs/en/SkiaSharp/SKFrontBufferedStream.xml @@ -0,0 +1,349 @@ + + + + + SkiaSharp + 1.56.0.0 + + + System.IO.Stream + + + + A read-only stream that buffers the specified first chunk of bytes. + This is useful for decoding images using streams that are not seekable, since  needs to read the first few bytes to determine the codec to use. + + + + + + Constructor + + 1.56.0.0 + + + + + + The stream to buffer. + Creates a new instance of  that wraps the specified stream. + + + + + + + + + Constructor + + 1.56.0.0 + + + + + + + The stream to buffer. + Whether or not to dispose the underlying stream when this stream is disposed. + Creates a new instance of  that wraps the specified stream. + + + + + + + + + Constructor + + 1.56.0.0 + + + + + + + The stream to buffer. + The number of bytes to buffer. + Creates a new instance of  that wraps the specified stream. + + + + + + + + + Constructor + + 1.56.0.0 + + + + + + + + The stream to buffer. + The number of bytes to buffer. + Whether or not to dispose the underlying stream when this stream is disposed. + Creates a new instance of  that wraps the specified stream. + + + + + + + + + Property + + 1.56.0.0 + + + System.Boolean + + + Gets a value indicating whether the current stream supports reading. + + + + + + + + + + + + Property + + 1.56.0.0 + + + System.Boolean + + + Gets a value indicating whether the current stream supports seeking. + + + + + + + + + + + + Property + + 1.56.0.0 + + + System.Boolean + + + Gets a value indicating whether the current stream supports writing. + + + + + + + + + + + + Field + + 1.56.0.0 + + + System.Int32 + + 4096 + + The default number of bytes to buffer (4096 bytes). + + + + + + + + + Method + + 1.56.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + Method + + 1.56.0.0 + + + System.Void + + + + Clears all buffers for this stream and causes any buffered data to be written to the underlying device. + + + + + + + + + Property + + 1.56.0.0 + + + System.Int64 + + + Gets the stream length in bytes. + + + + + + + + + + + + Property + + 1.56.0.0 + + + System.Int64 + + + Gets the position within the current stream. + + + + + + + + + + + + Method + + 1.56.0.0 + + + System.Int32 + + + + + + + + The buffer to which bytes are to be copied. + The byte offset in the buffer at which to begin reading bytes. + The number of bytes to be read. + Copies bytes from the current buffered stream to an array. + Returns the total number of bytes read into the buffer array. + + + + + + + + + Method + + 1.56.0.0 + + + System.Int64 + + + + + + + The byte offset relative to the specified origin. + The reference point from which to obtain the new position. + Sets the position within the current buffered stream. + Returns the new position within the current buffered stream. + + + + + + + + + Method + + 1.56.0.0 + + + System.Void + + + + + + An integer indicating the desired length of the current buffered stream in bytes. + Sets the length of the buffered stream. + + + + + + + + + Method + + 1.56.0.0 + + + System.Void + + + + + + + + The byte array from which to copy count bytes to the current buffered stream. + The offset in the buffer at which to begin copying bytes to the current buffered stream. + The number of bytes to be written to the current buffered stream. + Copies bytes to the buffered stream and advances the current position within the buffered stream by the number of bytes written. + + + + + + + diff --git a/docs/en/SkiaSharp/SKImageInfo.xml b/docs/en/SkiaSharp/SKImageInfo.xml index 446ac9c65..7d70c029d 100644 --- a/docs/en/SkiaSharp/SKImageInfo.xml +++ b/docs/en/SkiaSharp/SKImageInfo.xml @@ -231,8 +231,8 @@ - - + + Field 1.0.0.0 @@ -331,9 +331,77 @@ + + + + Field + + 1.56.0.0 + + + System.Int32 + + + The number of bits to shift left for the alpha color component. + + + + + + + + + Field + + 1.56.0.0 + + + System.Int32 + + + The number of bits to shift left for the blue color component. + + + + + + + + + Field + + 1.56.0.0 + + + System.Int32 + + + The number of bits to shift left for the green color component. + + + + + + + + + Field + + 1.56.0.0 + + + System.Int32 + + + The number of bits to shift left for the red color component. + + + + + - - + + Field 1.52.0.0 diff --git a/docs/en/SkiaSharp/SKPMColor.xml b/docs/en/SkiaSharp/SKPMColor.xml index 8ef31d443..23b06e992 100644 --- a/docs/en/SkiaSharp/SKPMColor.xml +++ b/docs/en/SkiaSharp/SKPMColor.xml @@ -11,7 +11,7 @@ 32-bit ARGB premultiplied color value. - The color components are always in a known order. + The byte order for this value is configuration dependent. This is different from , which is unpremultiplied, and is always in the same byte order. diff --git a/docs/en/index.xml b/docs/en/index.xml index f1998155f..664b291cf 100644 --- a/docs/en/index.xml +++ b/docs/en/index.xml @@ -385,6 +385,7 @@ +