Wireframe MAT
Summary
The Wireframe MAT renders the edges of polygons and curves as lines.
Parameters - Wireframe Page
color
- ⊞ - The color of the light reflected from the material.
- Red
colorr
-
- Green
colorg
-
- Blue
colorb
-
alpha
- The opacity of the material. This parameter is multiplied by point alpha of the object.
wireframemode
- ⊞ - Controls what wireframes are rendered.
- OpenGL Tessellated Wire Frame
tesselatedwireframe
- This wireframe follows what the actual rendered geometry on the GPU ends up being. This is usually just wired-triangles for any surface, regardless of the original primitive type.
- Topology Wire Frame
topologywireframe
- This wireframe follows the original SOP primitive types.
linewidth
- The width of the lines displayed in wireframe.
Parameters - Deform Page
Refer to the Deform Article for more information on doing deforms in TouchDesigner.
dodeform
- Enables deforms on this material.
deformdata
- ⊞ - Specifies where the deform bone data will be obtained.
- From a SOP
sop
-
- From another MAT
mat
-
- From a DeformIn MAT
deformin
-
targetsop
- Specifies the SOP that contains the deform capture attributes.
pcaptpath
- Specifies the name of the pCaptPath attribute to use. When your geometry has been put through a Bone Group SOP, the attributes will be split into names like pCaptPath0, pCaptPath1. You can only render 1 bone group at a time, so this should match the group you are rendering with this material.
pcaptdata
- Much like pCaptPath Attrib.
skelrootpath
- Specifies the path to the COMP where the root of the skeleton is located.
mat
- When obtaining deform data from a MAT or a Deform In MAT, this is where that MAT is specified.
Parameters - Common Page
Blending
Blending is summing the color value of the pixel being drawn and the pixel currently present in the Color-Buffer. Blending is typically used to simulate Transparency.
The blending equation is:
Final Pixel Value = (Source Blend * Source Color) + (Dest Blend * Destination Color)
blending
- This toggle enables and disables blending. However see the wiki article Transparency.
blendop
- ⊞ -
- Add
add
-
- Subtract
subtract
-
- Reverse Subtract
revsubtract
-
- Minimum
minimum
-
- Maximum
maximum
-
srcblend
- ⊞ - This value is multiplied by the color value of the pixel that is being written to the Color-Buffer (also know as the Source Color).
- Zero
zero
-
- Dest Color
dcol
-
- One Minus Dest Color
omdcol
-
- Source Alpha
sa
-
- One Minus Source Alpha
omsa
-
- Dest Alpha
da
-
- One Minus Dest Alpha
omda
-
- Source Alpha Saturate
sas
-
- One
one
-
- Constant Color
constantcol
-
- One Minus Constant Color
omconstantcol
-
- Constant Alpha
constanta
-
- One Minus Constant Alpha
omconstanta
-
destblend
- ⊞ - This value is multiplied by the color value of the pixel currently in the Color-Buffer (also known as the Destination Color).
- One
one
-
- Src Color
scol
-
- One Minus Src Color
omscol
-
- Source Alpha
sa
-
- One Minus Source Alpha
omsa
-
- Dest Alpha
da
-
- One Minus Dest Alpha
omda
-
- Zero
zero
-
- Dest Color
dcol
-
- One Minus Dest Color
omdcol
-
- Source Alpha Saturate
sas
-
- Constant Color
constantcol
-
- One Minus Constant Color
omconstantcol
-
- Constant Alpha
constanta
-
- One Minus Constant Alpha
omconstanta
-
separatealphafunc
- This toggle enables and disables separate blending options for the alpha values.
blendopa
- ⊞ -
- Add
add
-
- Subtract
subtract
-
- Reverse Subtract
revsubtract
-
- Minimum
minimum
-
- Maximum
maximum
-
srcblenda
- ⊞ - This value is multiplied by the alpha value of the pixel that is being written to the Color-Buffer (also know as the Source Alpha).
- Zero
zero
-
- Dest Color
dcol
-
- One Minus Dest Color
omdcol
-
- Source Alpha
sa
-
- One Minus Source Alpha
omsa
-
- Dest Alpha
da
-
- One Minus Dest Alpha
omda
-
- Source Alpha Saturate
sas
-
- One
one
-
- Constant Color
constantcol
-
- One Minus Constant Color
omconstantcol
-
- Constant Alpha
constanta
-
- One Minus Constant Alpha
omconstanta
-
destblenda
- ⊞ - This value is multiplied by the alpha value of the pixel currently in the Color-Buffer (also known as the Destination Alpha).
- One
one
-
- Src Color
scol
-
- One Minus Src Color
omscol
-
- Source Alpha
sa
-
- One Minus Source Alpha
omsa
-
- Dest Alpha
da
-
- One Minus Dest Alpha
omda
-
- Zero
zero
-
- Dest Color
dcol
-
- One Minus Dest Color
omdcol
-
- Source Alpha Saturate
sas
-
- Constant Color
constantcol
-
- One Minus Constant Color
omconstantcol
-
- Constant Alpha
constanta
-
- One Minus Constant Alpha
omconstanta
-
blendconstant
- ⊞ -
- Blend Constant Color
blendconstantr
-
- Blend Constant Color
blendconstantg
-
- Blend Constant Color
blendconstantb
-
blendconstanta
-
legacyalphabehavior
-
postmultalpha
- Multiplies the color by alpha after all other operations have taken place.
pointcolorpremult
- ⊞ -
- Already Pre-Multiplied By Alpha
alreadypremult
-
- Pre-Multiply By Alpha in Shader
premultinshader
-
depthtest
- Enables and disables the Depth-Test. If the depth-test is disabled, depths values aren't written to the Depth-Buffer.
depthfunc
- ⊞ - The depth value of the pixel being drawn is compared to the depth value currently in the depth-buffer using this function. If the test passes then the pixel is drawn to the Frame-Buffer. If the test fails the pixel is discarded and no changes are made to the Frame-Buffer.
- Less Than
less
-
- Less Than or Equal
lessorequal
-
- Equal
equal
-
- Greater Than
greater
-
- Greater Than or Equal
greaterorequal
-
- Not Equal
notequal
-
- Always
always
-
Depth Test
Depth-Testing is comparing the depth value of the pixel being drawn with the pixel currently in the Frame-Buffer. A pixel that is determined to be in-front of the pixel currently in the Frame-Buffer will be drawn over it. Pixels that are determined to be behind the pixel currently in the Frame-Buffer will not be drawn. Depth-Testing allows geometry in a 3D scene to occlude geometry behind it, and be occluded by geometry in-front of it regardless of the order the geometry was drawn.
For a more detailed description of Depth-Testing, refer to the Depth-Test article.
depthwriting
- If Write Depth Values is on, pixels that pass the depth-test will write their depth value to the Depth-Buffer. If this isn't on then no changes will be made to the Depth-Buffer, regardless of if the pixels drawn pass or fail the depth-test.
alphatest
- This enables or disables the pixel alpha test.
alphafunc
- ⊞ - This menu works in conjunction with the Alpha Threshold parameter below in determining which pixels to keep based on their alpha value.
- Less Than
less
-
- Less Than or Equal
lessorequal
-
- Greater Than
greater
-
- Greater Than or Equal
greaterorequal
-
alphathreshold
- This value is what the pixel's alpha is compared to to determine if the pixel should be drawn. Pixels with alpha greater than the Alpha Threshold will be drawn. Pixels with alpha less than or equal to the Alpha Threshold will not be drawn.
wireframe
- ⊞ - Enables and disables wire-frame rendering with the option of OpenGL Tesselated or Topology based wireframes.
- Off
off
-
- OpenGL Tesselated Wire Frame
tesselated
-
- Topology Wire Frame
topology
-
Alpha Test
Alpha-testing allows you to choose to draw or not draw a pixel based on its alpha value.
wirewidth
- This value is the width that the wires will be. This value is in pixels.
cullface
- ⊞ - Selects which faces to render.
- Use Render Setting
userender
- Use the render settings found in the Render or Render Pass TOP.
- Neither
neither
- Do not cull any faces, render everything.
- Back Faces
backfaces
- Cull back faces, render front faces.
- Front Faces
frontfaces
- Cull front faces, render back faces.
- Both Faces
bothfaces
- Cull both faces, render nothing.
polygonoffset
- Turns on the polygon offset feature.
polygonoffsetfactor
-
polygonoffsetunits
-
Wire Frame
The wire-frame feature will render the geometry as wire-frame, using the actual primitive type used in the render. What this means is surfaces like Metaballs, NURBs and Beziers will become a wire-frame of the triangles/triangle-strips used to render them (since these types of primitives can't be natively rendered in OpenGL).
Cull Face
The cull face parameter will cull faces from the render output. This can be used as an optimization or sometimes to remove artifacts. See Back-Face Culling for more infomation.
Polygon Depth Offset
This feature pushes the polygons back into space a tiny fraction. This is useful when you are rendering two polygons directly on-top of each other and are experiencing Z-Fighting. Refer to Polygon Depth Offset for more information. This is also an important feature when doing shadows.
Info CHOP Channels
Extra Information for the Wireframe MAT can be accessed via an Info CHOP.
Common MAT Info Channels
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.
TouchDesigner Build: