Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::LoadWriterPNG Class Reference

The LoadWriterPNG class is a ResourceLoadWriter capable of reading PNG files. More...

#include <ioPNG.hpp>

+ Inheritance diagram for vl::LoadWriterPNG:

Public Member Functions

 LoadWriterPNG ()
 
ref< ResourceDatabaseloadResource (const String &path) const
 
ref< ResourceDatabaseloadResource (VirtualFile *file) const
 
bool writeResource (const String &path, ResourceDatabase *resource) const
 
bool writeResource (VirtualFile *file, ResourceDatabase *resource) const
 
int compression () const
 
void setCompression (int compression)
 Sets the compression level used when saving a file. Should be between 0 and 9. More...
 
- Public Member Functions inherited from vl::ResourceLoadWriter
 ResourceLoadWriter (const String &load_extensions, const String &write_extensions)
 
bool canLoad (const String &extension) const
 Returns true if the given file type can be loaded. More...
 
const StringloadExtensions () const
 Returns the string containing the file types that can be loaded. More...
 
void setLoadExtensions (const String &extensions)
 Sets the set of file extensions that can be loaded. More...
 
bool canWrite (const String &extension) const
 Returns true if the given file type can be written. More...
 
const StringwriteExtensions () const
 Returns the string containing the file types that can be written. More...
 
void setWriteExtensions (const String &extensions)
 Sets the set of file extensions that can be written. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

int mCompression
 
- Protected Attributes inherited from vl::ResourceLoadWriter
String mLoadExtensions
 
String mWriteExtensions
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

The LoadWriterPNG class is a ResourceLoadWriter capable of reading PNG files.

Definition at line 57 of file ioPNG.hpp.

Constructor & Destructor Documentation

◆ LoadWriterPNG()

vl::LoadWriterPNG::LoadWriterPNG ( )
inline

Definition at line 62 of file ioPNG.hpp.

Member Function Documentation

◆ compression()

int vl::LoadWriterPNG::compression ( ) const
inline

Definition at line 101 of file ioPNG.hpp.

References mCompression.

Referenced by setCompression(), and writeResource().

◆ loadResource() [1/2]

ref<ResourceDatabase> vl::LoadWriterPNG::loadResource ( const String path) const
inlinevirtual

Implements vl::ResourceLoadWriter.

Definition at line 67 of file ioPNG.hpp.

References vl::loadPNG().

◆ loadResource() [2/2]

ref<ResourceDatabase> vl::LoadWriterPNG::loadResource ( VirtualFile file) const
inlinevirtual

Implements vl::ResourceLoadWriter.

Definition at line 76 of file ioPNG.hpp.

References vl::loadPNG().

◆ setCompression()

void vl::LoadWriterPNG::setCompression ( int  compression)
inline

Sets the compression level used when saving a file. Should be between 0 and 9.

Definition at line 103 of file ioPNG.hpp.

References compression(), and mCompression.

◆ writeResource() [1/2]

bool vl::LoadWriterPNG::writeResource ( const String path,
ResourceDatabase resource 
) const
inlinevirtual

◆ writeResource() [2/2]

bool vl::LoadWriterPNG::writeResource ( VirtualFile file,
ResourceDatabase resource 
) const
inlinevirtual

Member Data Documentation

◆ mCompression

int vl::LoadWriterPNG::mCompression
protected

Definition at line 106 of file ioPNG.hpp.

Referenced by compression(), and setCompression().


The documentation for this class was generated from the following file: