skia2/docs/SkWStream_Reference.bmh
Cary Clark 61313f38e1 Generate bookmaker indices
First cut at splitting bookmaker documentation into reference
and overview. Reference starts with a hyperlinked index,
generated from a public include.

This moves towards typing once, minimizing the information
duplicated in the .h file and the .bmh file.

TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=154630
Change-Id: I836622db9b1786bd28c0bce2536cd3caef6e5a32
Reviewed-on: https://skia-review.googlesource.com/c/154630
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-10-08 19:24:31 +00:00

355 lines
5.3 KiB
Plaintext

#Topic WStream
#Alias WStream_Reference ##
#Class SkWStream
#Code
#Populate
##
# ------------------------------------------------------------------------------
#Method virtual ~SkWStream()
#In Constructors
#Line # incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method SkWStream()
#In Constructors
#Line # incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method virtual bool write(const void* buffer, size_t size) = 0
#In incomplete
#Line # incomplete ##
Called to write bytes to a SkWStream. Returns true on success
#Param buffer the address of at least size bytes to be written to the stream
##
#Param size number of bytes in buffer to write to the stream
##
#Return true on success
##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method virtual void flush()
#In incomplete
#Line # incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method virtual size_t bytesWritten() const = 0
#In incomplete
#Line # incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool write8(U8CPU value)
#In incomplete
#Line # incomplete ##
Helpers.
#Param value incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool write16(U16CPU value)
#In incomplete
#Line # incomplete ##
#Param value incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool write32(uint32_t v)
#In incomplete
#Line # incomplete ##
#Param v incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeText(const char text[])
#In incomplete
#Line # incomplete ##
#Param text incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool newline()
#In incomplete
#Line # incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeDecAsText(int32_t)
#In incomplete
#Line # incomplete ##
#Param t incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeBigDecAsText(int64_t, int minDigits = 0)
#In incomplete
#Line # incomplete ##
#Param t incomplete ##
#Param minDigits incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeHexAsText(uint32_t, int minDigits = 0)
#In incomplete
#Line # incomplete ##
#Param t incomplete ##
#Param minDigits incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeScalarAsText(SkScalar)
#In incomplete
#Line # incomplete ##
#Param SkScalar incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeBool(bool v)
#In incomplete
#Line # incomplete ##
#Param v incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeScalar(SkScalar)
#In incomplete
#Line # incomplete ##
#Param SkScalar incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writePackedUInt(size_t)
#In incomplete
#Line # incomplete ##
#Param t incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method bool writeStream(SkStream* input, size_t length)
#In incomplete
#Line # incomplete ##
#Param input incomplete ##
#Param length incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
# ------------------------------------------------------------------------------
#Method static int SizeOfPackedUInt(size_t value)
#In incomplete
#Line # incomplete ##
This returns the number of bytes in the stream required to store
'value'.
#Param value incomplete ##
#Return incomplete ##
#Example
// incomplete
##
#SeeAlso incomplete
#Method ##
#Class SkWStream ##
#Topic WStream ##