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

pHYs chunk: http://www.w3.org/TR/PNG/#11pHYs More...

Inherits Hjg.Pngcs.Chunks.PngChunkSingle.

Public Member Functions

 PngChunkPHYS (ImageInfo info)
 
override ChunkOrderingConstraint GetOrderingConstraint ()
 Get ordering constrain
 
override ChunkRaw CreateRawChunk ()
 Serialization. Creates a Raw chunk, ready for write, from this chunk content
 
override void CloneDataFromRead (PngChunk other)
 Override to make a copy (normally deep) from other chunk
 
override void ParseFromRaw (ChunkRaw chunk)
 Deserialization. Given a Raw chunk, just rad, fills this chunk content
 
double GetAsDpi ()
 returns -1 if not in meters, or not equal
 
double[] GetAsDpi2 ()
 returns -1 if the physicial unit is unknown
 
void SetAsDpi (double dpi)
 same in both directions
 
void SetAsDpi2 (double dpix, double dpiy)
 
- Public Member Functions inherited from Hjg.Pngcs.Chunks.PngChunkSingle
 PngChunkSingle (String id, ImageInfo imgInfo)
 
sealed override bool AllowsMultiple ()
 This is implemented in PngChunkMultiple/PngChunSingle
 
override int GetHashCode ()
 
override bool Equals (object obj)
 
- Public Member Functions inherited from Hjg.Pngcs.Chunks.PngChunk
ChunkRaw createEmptyChunk (int len, bool alloc)
 
override String ToString ()
 Basic info: Id, length, Type name
 

Public Attributes

const String ID = ChunkHelper.pHYs
 

Properties

long PixelsxUnitX [get, set]
 
long PixelsxUnitY [get, set]
 
int Units [get, set]
 0: unknown 1:metre
 

Additional Inherited Members

- Public Types inherited from Hjg.Pngcs.Chunks.PngChunk
enum  ChunkOrderingConstraint {
  NONE, BEFORE_PLTE_AND_IDAT, AFTER_PLTE_BEFORE_IDAT, BEFORE_IDAT,
  NA
}
 Restrictions for chunk ordering, for ancillary chunks More...
 
- Static Public Member Functions inherited from Hjg.Pngcs.Chunks.PngChunk
static void FactoryRegister (String chunkId, Type type)
 Registers a Chunk ID in the factory, to instantiate a given type
 
static T CloneChunk< T > (T chunk, ImageInfo info)
 
- Protected Member Functions inherited from Hjg.Pngcs.Chunks.PngChunk
 PngChunk (String id, ImageInfo imgInfo)
 Constructs an empty chunk
 
- Protected Attributes inherited from Hjg.Pngcs.Chunks.PngChunk
readonly ImageInfo ImgInfo
 Image basic info, mostly for some checks
 

Detailed Description

pHYs chunk: http://www.w3.org/TR/PNG/#11pHYs

Constructor & Destructor Documentation

Hjg.Pngcs.Chunks.PngChunkPHYS.PngChunkPHYS ( ImageInfo  info)

Member Function Documentation

override ChunkOrderingConstraint Hjg.Pngcs.Chunks.PngChunkPHYS.GetOrderingConstraint ( )
virtual

Get ordering constrain

Returns

Implements Hjg.Pngcs.Chunks.PngChunk.

override ChunkRaw Hjg.Pngcs.Chunks.PngChunkPHYS.CreateRawChunk ( )
virtual

Serialization. Creates a Raw chunk, ready for write, from this chunk content

Implements Hjg.Pngcs.Chunks.PngChunk.

override void Hjg.Pngcs.Chunks.PngChunkPHYS.CloneDataFromRead ( PngChunk  other)
virtual

Override to make a copy (normally deep) from other chunk

Parameters
other

Implements Hjg.Pngcs.Chunks.PngChunk.

override void Hjg.Pngcs.Chunks.PngChunkPHYS.ParseFromRaw ( ChunkRaw  c)
virtual

Deserialization. Given a Raw chunk, just rad, fills this chunk content

Implements Hjg.Pngcs.Chunks.PngChunk.

double Hjg.Pngcs.Chunks.PngChunkPHYS.GetAsDpi ( )

returns -1 if not in meters, or not equal

Returns
double [] Hjg.Pngcs.Chunks.PngChunkPHYS.GetAsDpi2 ( )

returns -1 if the physicial unit is unknown

Returns
void Hjg.Pngcs.Chunks.PngChunkPHYS.SetAsDpi ( double  dpi)

same in both directions

Parameters
dpi
void Hjg.Pngcs.Chunks.PngChunkPHYS.SetAsDpi2 ( double  dpix,
double  dpiy 
)

Member Data Documentation

const String Hjg.Pngcs.Chunks.PngChunkPHYS.ID = ChunkHelper.pHYs

Property Documentation

long Hjg.Pngcs.Chunks.PngChunkPHYS.PixelsxUnitX
getset
long Hjg.Pngcs.Chunks.PngChunkPHYS.PixelsxUnitY
getset
int Hjg.Pngcs.Chunks.PngChunkPHYS.Units
getset

0: unknown 1:metre