Nuke binary plugins 16.0.1
 
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
DD::Image::Pixel Class Reference

#include <Pixel.h>

Public Member Functions

 Pixel ()
 Default ctor leaves ChannelSet empty (set to Mask_None.)
 
 Pixel (const Pixel &b)
 
 Pixel (const ChannelSetInit c)
 
 Pixel (const ChannelSet &c)
 
 Pixel (Channel c)
 
float & operator[] (Channel z)
 
const float & operator[] (Channel z) const
 
float * array ()
 
InterestRatchet * interestRatchet ()
 
void setInterestRatchet (InterestRatchet *interestRatchet)
 
void copyInterestRatchet (const Pixel &from)
 
void set (float d)
 
void set (const ChannelSet &c, float d)
 
void set (const ChannelPack &c, float d)
 
void erase ()
 
void erase (Channel z)
 
void erase (const ChannelSet &mask)
 
void erase (const ChannelPack &mask)
 
void replace (const Pixel &b, const ChannelSet &c)
 
void replace (const Pixel &b, const ChannelPack &c)
 
void replace (const Pixel &b)
 
Pixel get (const ChannelSet &getChans) const
 Return a Pixel filled with \getChans channels from this one.
 
Pixel get (const ChannelPack &getChans) const
 
Pixel & operator= (float d)
 
Pixel operator* (float d) const
 
Pixel & operator*= (float d)
 
Pixel operator* (const Pixel &v) const
 
Pixel & operator*= (const Pixel &v)
 
Pixel operator/ (float d) const
 
Pixel & operator/= (float d)
 
Pixel operator/ (const Pixel &v) const
 
Pixel & operator/= (const Pixel &v)
 
Pixel operator+ (float d) const
 
Pixel & operator+= (float d)
 
Pixel operator+ (const Pixel &v) const
 
Pixel & operator+= (const Pixel &v)
 
Pixel operator- (float d) const
 
Pixel & operator-= (float d)
 
Pixel operator- (const Pixel &v) const
 
Pixel & operator-= (const Pixel &v)
 
void lerp (const Pixel &b, float t)
 Destructive linear interpolate between this Pixel and Pixel b by t(0..1).
 
void lerp (const Pixel &b, float t, const ChannelSet &channels)
 
void lerp (const Pixel &b, float t, const ChannelPack &channels)
 
void over (const Pixel &A, float a, const ChannelSet &channels)
 
void over (const Pixel &A, float a, const ChannelPack &channels)
 
void over (const Pixel &A, float a)
 
void under (const Pixel &A, const ChannelSet &channels)
 
void under (const Pixel &A, const ChannelPack &channels)
 
void under (const Pixel &A)
 
void multiply (float d, const ChannelSet &channels)
 
void multiply (float d, const ChannelPack &channels)
 
void multiply (const Pixel &b, const ChannelSet &channels)
 
void multiply (const Pixel &b, const ChannelPack &channels)
 
void multiplyVec2Chans (float x, float y, Channel *clist)
 
void multiplyVec2Chans (const fdk::Vec2f &v, Channel *clist)
 
void multiplyVec3Chans (float x, float y, float z, Channel *clist)
 
void multiplyVec3Chans (const fdk::Vec3f &v, Channel *clist)
 
void multiplyVec4Chans (float x, float y, float z, float w, Channel *clist)
 
void multiplyVec4Chans (const fdk::Vec4f &v, Channel *clist)
 
void divide (float d, const ChannelSet &channels)
 
void divide (float d, const ChannelPack &channels)
 
void divide (const Pixel &b, const ChannelSet &channels)
 
void divide (const Pixel &b, const ChannelPack &channels)
 
void divideVec2Chans (float x, float y, Channel *clist)
 
void divideVec2Chans (const fdk::Vec2f &v, Channel *clist)
 
void divideVec3Chans (float x, float y, float z, Channel *clist)
 
void divideVec3Chans (const fdk::Vec3f &v, Channel *clist)
 
void divideVec4Chans (float x, float y, float z, float w, Channel *clist)
 
void divideVec4Chans (const fdk::Vec4f &v, Channel *clist)
 
void plus (float d, const ChannelSet &channels)
 
void plus (float d, const ChannelPack &channels)
 
void plus (const Pixel &b, const ChannelSet &channels)
 
void plus (const Pixel &b, const ChannelPack &channels)
 
void plusVec2Chans (float x, float y, Channel *clist)
 
void plusVec2Chans (const fdk::Vec2f &v, Channel *clist)
 
void plusVec3Chans (float x, float y, float z, Channel *clist)
 
void plusVec3Chans (const fdk::Vec3f &v, Channel *clist)
 
void plusVec4Chans (float x, float y, float z, float w, Channel *clist)
 
void plusVec4Chans (const fdk::Vec4f &v, Channel *clist)
 
void minus (float d, const ChannelSet &channels)
 
void minus (float d, const ChannelPack &channels)
 
void minus (const Pixel &b, const ChannelSet &channels)
 
void minus (const Pixel &b, const ChannelPack &channels)
 
void minusVec2Chans (float x, float y, Channel *clist)
 
void minusVec2Chans (const fdk::Vec2f &v, Channel *clist)
 
void minusVec3Chans (float x, float y, float z, Channel *clist)
 
void minusVec3Chans (const fdk::Vec3f &v, Channel *clist)
 
void minusVec4Chans (float x, float y, float z, float w, Channel *clist)
 
void minusVec4Chans (const fdk::Vec4f &v, Channel *clist)
 
void setRGBAToBlack ()
 Convenience color functions.
 
void setRGBAToWhite ()
 
void setRGBToBlack ()
 
void setRGBToWhite ()
 
void setOpacityToFull ()
 
void setOpacityToNone ()
 
fdk::Vec3f getVec3Chans (Channel *clist) const
 
fdk::Vec3f getVec3Chans (Channel x, Channel y, Channel z) const
 
fdk::Vec4f getVec4Chans (Channel *clist) const
 
fdk::Vec4f getVec4Chans (Channel x, Channel y, Channel z, Channel w) const
 
void setVec2Chans (float x, float y, Channel *clist)
 
void setVec2Chans (const fdk::Vec2f &v, Channel *clist)
 
void setVec3Chans (float x, float y, float z, Channel *clist)
 
void setVec3Chans (const fdk::Vec3f &v, Channel *clist)
 
void setVec4Chans (float x, float y, float z, float w, Channel *clist)
 
void setVec4Chans (const fdk::Vec4f &v, Channel *clist)
 
fdk::Vec4f & P ()
 
const fdk::Vec4f & P () const
 
float & x ()
 
float x () const
 
float & y ()
 
float y () const
 
float & z ()
 
float z () const
 
float & w ()
 
float w () const
 
float & Z ()
 
float Z () const
 
float & Zf ()
 
float Zf () const
 
float & Zb ()
 
float Zb () const
 
fdk::Vec3f & PL ()
 
const fdk::Vec3f & PL () const
 
fdk::Vec3f & PW ()
 
const fdk::Vec3f & PW () const
 
fdk::Vec3f & MB ()
 
const fdk::Vec3f & MB () const
 
fdk::Vec4f & UV ()
 
const fdk::Vec4f & UV () const
 
fdk::Vec3f & N ()
 
const fdk::Vec3f & N () const
 
fdk::Vec3f & VEL ()
 
const fdk::Vec3f & VEL () const
 
fdk::Vec4f & Cf ()
 
const fdk::Vec4f & Cf () const
 
fdk::Vec4f & rgba ()
 
const fdk::Vec4f & rgba () const
 
fdk::Vec3f & rgb ()
 
const fdk::Vec3f & rgb () const
 
float & r ()
 
float r () const
 
float & g ()
 
float g () const
 
float & b ()
 
float b () const
 
float & a ()
 
float a () const
 
float & red ()
 
float red () const
 
float & green ()
 
float green () const
 
float & blue ()
 
float blue () const
 
float & alpha ()
 
float alpha () const
 
float & coverage ()
 
float coverage () const
 
float & cutoutAlpha ()
 
float cutoutAlpha () const
 
float & cutoutDepth ()
 
float cutoutDepth () const
 
fdk::Vec3f & color ()
 
const fdk::Vec3f & color () const
 
float & opacity ()
 
float opacity () const
 
fdk::Vec3f & position ()
 
const fdk::Vec3f & position () const
 
fdk::Vec3f & velocity ()
 
const fdk::Vec3f & velocity () const
 
fdk::Vec3f & normal ()
 
const fdk::Vec3f & normal () const
 
 mFnDeprecatedInNuke14 ("under(Pixel, float, ChannelSet) has been deprecated, use under(Pixel, ChannelSet) instead.") void under(const Pixel &A
 
 mFnDeprecatedInNuke14 ("under(Pixel, float) has been deprecated, use under(Pixel) instead.") void under(const Pixel &A
 

Public Attributes

ChannelSet channels
 
float chan [Chan_Last+1]
 
float a
 
float const ChannelSet & channels
 

Detailed Description

Holds a single pixel's worth of image data. Contains a ChannelSet to indicate active planes. _interestRatchet is only useful when the Pixel is being passed to Iop Tile sampling methods as it helps speed up repeated Tile queries.

Member Function Documentation

◆ interestRatchet()

InterestRatchet * DD::Image::Pixel::interestRatchet ( )
inline

Set this when Pixel is being passed to Iop Tile sampling methods so that repeated queries of the same Tile are accelerated. It is not useful or needed for general Pixel usage.

Referenced by DD::Image::Iop::doSample(), and DD::Image::Transform::sample().


©2025 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.foundry.com