Namespace: go.std.image.png

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the image/png package.

Package png implements a PNG image decoder and encoder.

The PNG specification is at https://www.w3.org/TR/PNG/.

Index

• *CompressionLevel
• *Encoder
• *EncoderBuffer
• *FormatError
• *UnsupportedError
• BestCompression
• BestSpeed
• CompressionLevel
• Decode
• DecodeConfig
• DefaultCompression
• Encode
• Encoder
• EncoderBuffer
• EncoderBufferPool
• FormatError
• NoCompression
• UnsupportedError
• arrayOfCompressionLevel
• arrayOfEncoder
• arrayOfEncoderBuffer
• arrayOfEncoderBufferPool
• arrayOfFormatError
• arrayOfUnsupportedError

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

• BestCompression

  GoObject v1.0

• BestSpeed

  GoObject v1.0

• DefaultCompression

  GoObject v1.0

• NoCompression

  GoObject v1.0

Functions, Macros, and Special Forms

• Decode

  Function v1.0

  (Decode r)
  

  Decode reads a PNG image from r and returns it as an image.Image.
  The type of Image returned depends on the PNG contents.
  
  Go input arguments: (r io.Reader)
  
  Go returns: (image.Image, error)
  
  Joker input arguments: [^go.std.io/Reader r]
  
  Joker returns: [^go.std.image/Image, ^Error]

• DecodeConfig

  Function v1.0

  (DecodeConfig r)
  

  DecodeConfig returns the color model and dimensions of a PNG image without
  decoding the entire image.
  
  Go input arguments: (r io.Reader)
  
  Go returns: (image.Config, error)
  
  Joker input arguments: [^go.std.io/Reader r]
  
  Joker returns: [^go.std.image/Config, ^Error]

• Encode

  Function v1.0

  (Encode w m)
  

  Encode writes the Image m to w in PNG format. Any Image may be
  encoded, but images that are not image.NRGBA might be encoded lossily.
  
  Go input arguments: (w io.Writer, m image.Image)
  
  Go returns: error
  
  Joker input arguments: [^go.std.io/Writer w, ^go.std.image/Image m]
  
  Joker returns: ^Error

Types

• *CompressionLevel

  Concrete Type v1.0

  CompressionLevel indicates the compression level.
  

• *Encoder

  Concrete Type v1.0

  Encoder configures encoding PNG images.
  

• Encode

  Receiver for *Encoder v1.0

  ([w m])
  

  Encode writes the Image m to w in PNG format.
  

• *EncoderBuffer

  Concrete Type v1.0

  EncoderBuffer holds the buffers used for encoding PNG images.
  

• *FormatError

  Concrete Type v1.0

  A FormatError reports that the input is not a valid PNG.
  

• *UnsupportedError

  Concrete Type v1.0

  An UnsupportedError reports that the input uses a valid but unimplemented PNG feature.
  

• CompressionLevel

  Concrete Type v1.0

  CompressionLevel indicates the compression level.
  

• Encoder

  Concrete Type v1.0

  Encoder configures encoding PNG images.
  

• EncoderBuffer

  Concrete Type v1.0

  EncoderBuffer holds the buffers used for encoding PNG images.
  

• EncoderBufferPool

  Abstract Type v1.0

  EncoderBufferPool is an interface for getting and returning temporary
  instances of the EncoderBuffer struct. This can be used to reuse buffers
  when encoding multiple images.
  

• Get

  Method for EncoderBufferPool v1.0

  ([])
  

• Put

  Method for EncoderBufferPool v1.0

  ([arg1])
  

• FormatError

  Concrete Type v1.0

  A FormatError reports that the input is not a valid PNG.
  

• Error

  Receiver for FormatError v1.0

  ([])
  

• UnsupportedError

  Concrete Type v1.0

  An UnsupportedError reports that the input uses a valid but unimplemented PNG feature.
  

• Error

  Receiver for UnsupportedError v1.0

  ([])
  

• arrayOfCompressionLevel

  Concrete Type v1.0

  CompressionLevel indicates the compression level.
  

• arrayOfEncoder

  Concrete Type v1.0

  Encoder configures encoding PNG images.
  

• arrayOfEncoderBuffer

  Concrete Type v1.0

  EncoderBuffer holds the buffers used for encoding PNG images.
  

• arrayOfEncoderBufferPool

  Concrete Type v1.0

  EncoderBufferPool is an interface for getting and returning temporary
  instances of the EncoderBuffer struct. This can be used to reuse buffers
  when encoding multiple images.
  

• arrayOfFormatError

  Concrete Type v1.0

  A FormatError reports that the input is not a valid PNG.
  

• arrayOfUnsupportedError

  Concrete Type v1.0

  An UnsupportedError reports that the input uses a valid but unimplemented PNG feature.