Data
Composite
BufferedReaderHashMapPFontPGraphicsPImagePShaderPShapePVectorPrintWriterTableRowTableXMLstd::mapstd::vector
Array Functions
append()arrayCopy()concat()expand()reverse()shorten()sort()splice()subset()
Conversion
binary()hex()str()unbinary()unhex()
Primitive
color
String Functions
join()matchAll()match()nf()split()splitTokens()trim()
Input
Files
createInput()createReader()launch()loadBytes()loadJSONArray()loadJSONObject()loadStrings()loadTable()loadXML()parseJSONArray()parseJSONObject()parseXML()selectFolder()selectInput()
Time & Date
day()hour()millis()minute()month()second()year()
Keyboard
keykeyPressedkeyCodekeyReleased()keyPressed()keyTyped()
Mouse
mouseButtonmouseClicked()mouseDragged()mouseMoved()mousePressedmousePressed()mouseWheel()mouseReleased()mouseXmouseYpmouseXpmouseY
Constants
HALF_PIPIQUARTER_PITAUTWO_PI
Typography
Loading & Displaying
PFontcreateFont()loadFont()textFont()text()
Attributes
textAlign()textLeading()textMode()textSize()textWidth()
Metrics
textAscent()textDescent()
Rendering
PGraphicsblendMode()clip()createGraphics()hint()noClip()
Shaders
PShaderloadShader()resetShader()shader()
Image
PImagecreateImage()
Pixels
blend()copy()filter()get()loadPixels()mask()pixels[]set()updatePixels()
Loading & Displaying
image()imageMode()loadImage()noTint()tint()
Textures
texture()textureMode()textureWrap()
Shape
PShapecreateShape()loadShape()
2D Primitives
arc()circle()ellipse()line()point()quad()rect()square()triangle()
Vertex
beginContour()beginShape()bezierVertex()curveVertex()endContour()endShape()quadraticVertex()vertex()
Curves
bezierDetail()bezierPoint()bezierTangent()bezier()curveDetail()curvePoint()curveTangent()curveTightness()curve()
3D Primitives
box()sphere()sphereDetail()
Attributes
ellipseMode()rectMode()strokeCap()strokeJoin()strokeWeight()
Loading & Displaying
shape()shapeMode()
Math
PVector
Calculation
abs()ceil()constrain()dist()exp()floor()lerp()log()mag()map()max()min()norm()pow()round()sq()sqrt()
Trigonometry
acos()asin()atan2()atan()cos()degrees()radians()sin()tan()
Random
noise()noiseDetail()noiseSeed()randomGaussian()randomSeed()random()
Output
Files
PrintWritercreateOutput()createWriter()saveBytes()saveJSONArray()saveJSONObject()saveStrings()saveTable()saveXML()selectOutput()
Text Area
print()printArray()println()
Image
save()saveFrame()
Color
Creating & Reading
alpha()blue()brightness()color()green()hue()lerpColor()red()saturation()
Setting
background()clear()colorMode()fill()noFill()noStroke()stroke()
Lights Camera
Lights
ambientLight()directionalLight()lightFalloff()lightSpecular()lights()noLights()normal()pointLight()spotLight()
Material Properties
ambient()emissive()shininess()specular()
Camera
beginCamera()camera()endCamera()frustum()ortho()perspective()printCamera()printProjection()
Coordinates
modelX()modelY()modelZ()screenX()screenY()screenZ()
Transform
applyMatrix()popMatrix()printMatrix()pushMatrix()resetMatrix()rotateX()rotateY()rotateZ()rotate()scale()shearX()shearY()translate()
Structure
draw()exit()loop()noLoop()pop()popMatrix()popStyle()push()pushMatrix()pushStyle()redraw()setup()thread()delay()
Environment
cursor()deltaTimedisplayHeightdisplayWidthfocusedframeCountframeRateframeRate()fullScreen()heighthint()noCursor()noSmooth()pixelDensity()pixelHeightpixelWidthsize()smooth()widthwindowMoved()windowResizable()windowResize()windowResized()windowTitle()

mask()

Image / Pixels

Description

Applies a mask to a PImage. The mask image is a grayscale image where white pixels are opaque and black pixels are transparent.

Syntax

img.mask(const PImage& m)

Parameters

NameTypeDescription
mPImagegrayscale image to use as mask

Returns

void

Related

PImage_classloadPixelsfilter

Under the Hood

Implementation in Processing.h / Processing.cpp:

Loading...