PngCs  1.1.4
A C# library for read/write PNG images
Public Member Functions | Protected Attributes | List of all members
Hjg.Pngcs.Chunks.ChunksList Class Reference

All chunks that form an image, read or to be written More...

Inherited by Hjg.Pngcs.Chunks.ChunksListForWrite.

Public Member Functions

Dictionary< String, int > GetChunksKeys ()
 Keys of processed (read or writen) chunks
 
List< PngChunkGetChunks ()
 Returns a copy of the chunk list (but the chunks are not copied)
 
void AppendReadChunk (PngChunk chunk, int chunkGroup)
 Adds chunk in next position. This is used only by the pngReader
 
List< PngChunkGetById (String id)
 All chunks with this ID
 
List< PngChunkGetById (String id, String innerid)
 Same as ID, but we an additional discriminator for textual keys
 
PngChunk GetById1 (String id)
 Returns only one chunk
 
PngChunk GetById1 (String id, bool failIfMultiple)
 Returns only one chunk
 
PngChunk GetById1 (String id, String innerid, bool failIfMultiple)
 Sames as GetById1(String id, bool failIfMultiple) but allows an additional innerid
 
List< PngChunkGetEquivalent (PngChunk chunk)
 Finds all chunks "equivalent" to this one
 
override String ToString ()
 Only the amount of chunks
 
String ToStringFull ()
 Detailed information, for debugging
 

Protected Attributes

List< PngChunkchunks
 Includes all chunks, but IDAT is a single pseudo chunk without data
 

Detailed Description

All chunks that form an image, read or to be written

http://www.w3.org/TR/PNG/#table53

Member Function Documentation

Dictionary<String,int> Hjg.Pngcs.Chunks.ChunksList.GetChunksKeys ( )

Keys of processed (read or writen) chunks

Returns
key:chunk id, val: number of occurrences
List<PngChunk> Hjg.Pngcs.Chunks.ChunksList.GetChunks ( )

Returns a copy of the chunk list (but the chunks are not copied)

This should not be used for general metadata handling

Returns
void Hjg.Pngcs.Chunks.ChunksList.AppendReadChunk ( PngChunk  chunk,
int  chunkGroup 
)

Adds chunk in next position. This is used only by the pngReader

Parameters
chunk
chunkGroup
List<PngChunk> Hjg.Pngcs.Chunks.ChunksList.GetById ( String  id)

All chunks with this ID

The GetBy... methods never include queued chunks

Parameters
id
Returns
List, empty if none
List<PngChunk> Hjg.Pngcs.Chunks.ChunksList.GetById ( String  id,
String  innerid 
)

Same as ID, but we an additional discriminator for textual keys

If innerid!=null and the chunk is PngChunkTextVar or PngChunkSPLT, it's filtered by that id

Parameters
id
inneridOnly used for text and SPLT chunks
Returns
List, empty if none
PngChunk Hjg.Pngcs.Chunks.ChunksList.GetById1 ( String  id)

Returns only one chunk

Parameters
id
Returns
First chunk found, null if not found
PngChunk Hjg.Pngcs.Chunks.ChunksList.GetById1 ( String  id,
bool  failIfMultiple 
)

Returns only one chunk

Parameters
id
failIfMultipletrue, and more than one found: exception
Returns
null if not found
PngChunk Hjg.Pngcs.Chunks.ChunksList.GetById1 ( String  id,
String  innerid,
bool  failIfMultiple 
)

Sames as GetById1(String id, bool failIfMultiple) but allows an additional innerid

Parameters
id
innerid
failIfMultipletrue, and more than one found: exception
Returns
null if not found
List<PngChunk> Hjg.Pngcs.Chunks.ChunksList.GetEquivalent ( PngChunk  chunk)

Finds all chunks "equivalent" to this one

Parameters
chunk
Returns
Empty if nothing found
override String Hjg.Pngcs.Chunks.ChunksList.ToString ( )

Only the amount of chunks

Returns
String Hjg.Pngcs.Chunks.ChunksList.ToStringFull ( )

Detailed information, for debugging

Returns

Member Data Documentation

List<PngChunk> Hjg.Pngcs.Chunks.ChunksList.chunks
protected

Includes all chunks, but IDAT is a single pseudo chunk without data