krita

KisSubstrate Class Reference

#include <kis_substrate.h>

Inherits KShared.

List of all members.


Detailed Description

This abstract class defines the properties of a substrate -- that is, the simulation of the paper or canvas for natural media.

Subclass this interface to define a specific type of substrate: repeating, or full-size, with specific and cool ways of generating the surface, or maybe based on scans of real substrates.

Definition at line 47 of file kis_substrate.h.


Public Member Functions

 KisSubstrate (KisImage *)
virtual void getPixels (KisSubstratePixel *substrate, const QRect &rc) const =0
virtual void writePixels (const KisSubstratePixel *substrate, const QRect &rc)=0
virtual void getPixel (KisSubstratePixel *ksp, int x, int y) const =0
virtual void writePixel (const KisSubstratePixel &ksp, int x, int y)=0

Member Function Documentation

virtual void KisSubstrate::getPixels ( KisSubstratePixel substrate,
const QRect &  rc 
) const [pure virtual]

Copy the pixel values in the specified rect into an array of Substrate.

Make sure the array is big enough!

virtual void KisSubstrate::writePixels ( const KisSubstratePixel substrate,
const QRect &  rc 
) [pure virtual]

Copy the specified rect of substrate pixels onto the substrate.

Make sure the array is big enough.

virtual void KisSubstrate::getPixel ( KisSubstratePixel ksp,
int  x,
int  y 
) const [pure virtual]

Read the value at the specified position into the given substrate pixel.

virtual void KisSubstrate::writePixel ( const KisSubstratePixel ksp,
int  x,
int  y 
) [pure virtual]

Copy the value of the given substrate pixel to the specified location.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys