Skip to content

Fix typos in HostSupport subdirectory #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

Fix typos in HostSupport subdirectory #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion HostSupport/examples/cacheDemo.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public :
printf("\n");

if(isQuestion) {
/// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes
/// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes
return kOfxStatReplyYes;
}
else {
Expand Down
8 changes: 4 additions & 4 deletions HostSupport/examples/hostDemoClipInstance.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,8 +261,8 @@ namespace MyHost {
/// Field Order - Which spatial field occurs temporally first in a frame.
/// \returns
/// - kOfxImageFieldNone - the clip material is unfielded
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame
const std::string &MyClipInstance::getFieldOrder() const
{
/// our clip is pretending to be progressive PAL SD, so return kOfxImageFieldNone
Expand Down Expand Up @@ -300,8 +300,8 @@ namespace MyHost {

// Continuous Samples -
//
// 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen).
// 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen).
bool MyClipInstance::getContinuousSamples() const
{
return false;
Expand Down
10 changes: 5 additions & 5 deletions HostSupport/examples/hostDemoClipInstance.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

namespace MyHost {

// foward
// forward
class MyClipInstance;

/// make an image up
Expand Down Expand Up @@ -77,8 +77,8 @@ namespace MyHost {
/// Field Order - Which spatial field occurs temporally first in a frame.
/// \returns
/// - kOfxImageFieldNone - the clip material is unfielded
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame
virtual const std::string &getFieldOrder() const;

// Connected -
Expand All @@ -98,8 +98,8 @@ namespace MyHost {

// Continuous Samples -
//
// 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen).
// 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen).
virtual bool getContinuousSamples() const;

/// override this to fill in the image at the given time.
Expand Down
2 changes: 1 addition & 1 deletion HostSupport/examples/hostDemoEffectInstance.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ namespace MyHost {

// The extent of the current project in canonical coordinates.
// The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems
// for more infomation on the project extent. The extent is in canonical coordinates and only
// for more information on the project extent. The extent is in canonical coordinates and only
// returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD
// project would have an extent of 768, 576.
virtual void getProjectExtent(double& xSize, double& ySize) const;
Expand Down
2 changes: 1 addition & 1 deletion HostSupport/examples/hostDemoHostDescriptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ namespace MyHost
printf("\n");

if(isQuestion) {
/// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes
/// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes
return kOfxStatReplyYes;
}
else {
Expand Down
22 changes: 11 additions & 11 deletions HostSupport/include/ofxhClip.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace OFX {

virtual ~ClipBase() { }

/// ctor, when copy constructing an instance from a descripto
/// ctor, when copy constructing an instance from a descriptor
explicit ClipBase(const ClipBase &other);

/// name of the clip
Expand Down Expand Up @@ -106,8 +106,8 @@ namespace OFX {
protected:
ImageEffect::Instance* _effectInstance; ///< image effect instance
bool _isOutput; ///< are we the output clip
std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip prefernces action.
std::string _components; ///< what components do we have. Set during the clip prefernces action.
std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip preferences action.
std::string _components; ///< what components do we have. Set during the clip preferences action.

public:
ClipInstance(ImageEffect::Instance* effectInstance, ClipDescriptor& desc);
Expand Down Expand Up @@ -224,8 +224,8 @@ namespace OFX {
/// Field Order - Which spatial field occurs temporally first in a frame.
/// \returns
/// - kOfxImageFieldNone - the clip material is unfielded
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame
/// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame
/// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame
virtual const std::string &getFieldOrder() const = 0;

// Connected -
Expand All @@ -245,8 +245,8 @@ namespace OFX {

// Continuous Samples -
//
// 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen).
// 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames),
// 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen).
virtual bool getContinuousSamples() const = 0;

/// override this to fill in the image at the given time.
Expand All @@ -271,7 +271,7 @@ namespace OFX {
virtual OfxRectD getRegionOfDefinition(OfxTime time) const = 0;

/// given the colour component, find the nearest set of supported colour components
/// override this for extra wierd custom component depths
/// override this for extra weird custom component depths
virtual const std::string &findSupportedComp(const std::string &s) const;
};

Expand All @@ -291,7 +291,7 @@ namespace OFX {
ImageBase();

/// construct from a clip instance, but leave the
/// filling it to the calling code via the propery set
/// filling it to the calling code via the property set
explicit ImageBase(ClipInstance& instance);

// Render Scale (renderScaleX,renderScaleY) -
Expand Down Expand Up @@ -365,7 +365,7 @@ namespace OFX {
Image();

/// construct from a clip instance, but leave the
/// filling it to the calling code via the propery set
/// filling it to the calling code via the property set
explicit Image(ClipInstance& instance);

// Render Scale (renderScaleX,renderScaleY) -
Expand Down Expand Up @@ -430,7 +430,7 @@ namespace OFX {
Texture();

/// construct from a clip instance, but leave the
/// filling it to the calling code via the propery set
/// filling it to the calling code via the property set
explicit Texture(ClipInstance& instance);

// Render Scale (renderScaleX,renderScaleY) -
Expand Down
20 changes: 10 additions & 10 deletions HostSupport/include/ofxhImageEffect.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ namespace OFX {
virtual OfxStatus flushOpenGLResources() const = 0;
# endif

/// override this to use your own memory instance - must inherrit from memory::instance
/// override this to use your own memory instance - must inherit from memory::instance
virtual Memory::Instance* newMemoryInstance(size_t nBytes);

// return an memory::instance calls makeMemoryInstance that can be overriden
// return an memory::instance calls makeMemoryInstance that can be overridden
Memory::Instance* imageMemoryAlloc(size_t nBytes);
};

Expand Down Expand Up @@ -335,7 +335,7 @@ namespace OFX {
/// get output fielding as set in the clip preferences action.
const std::string &getOutputPreMultiplication() const {return _outputPreMultiplication; }

/// get the output frame rate, as set in the clip prefences action.
/// get the output frame rate, as set in the clip preferences action.
double getOutputFrameRate() const {return _outputFrameRate;}


Expand Down Expand Up @@ -368,16 +368,16 @@ namespace OFX {
/// params and input images are exactly the same. eg: random noise generator
bool isFrameVarying() const {return _frameVarying;}

/// pure virtuals that must be overriden
/// pure virtuals that must be overridden
virtual ClipInstance* getClip(const std::string& name) const;

/// override this to make processing abort, return 1 to abort processing
virtual int abort();

/// override this to use your own memory instance - must inherrit from memory::instance
/// override this to use your own memory instance - must inherit from memory::instance
virtual Memory::Instance* newMemoryInstance(size_t nBytes);

// return an memory::instance calls makeMemoryInstance that can be overriden
// return an memory::instance calls makeMemoryInstance that can be overridden
Memory::Instance* imageMemoryAlloc(size_t nBytes);

/// make a clip
Expand Down Expand Up @@ -410,10 +410,10 @@ namespace OFX {
/// overridden from Property::Notify
virtual void notify(const std::string &name, bool singleValue, int indexOrN);

/// overridden from gethook, get the virutals for viewport size, pixel scale, background colour
/// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour
virtual double getDoubleProperty(const std::string &name, int index) const;

/// overridden from gethook, get the virutals for viewport size, pixel scale, background colour
/// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour
virtual void getDoublePropertyN(const std::string &name, double *values, int count) const;

/// overridden from gethook, don't know what to do
Expand Down Expand Up @@ -441,7 +441,7 @@ namespace OFX {

// The extent of the current project in canonical coordinates.
// The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems
// for more infomation on the project extent. The extent is in canonical coordinates and only
// for more information on the project extent. The extent is in canonical coordinates and only
// returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD
// project would have an extent of 768, 576.
virtual void getProjectExtent(double& xSize, double& ySize) const = 0;
Expand Down Expand Up @@ -611,7 +611,7 @@ namespace OFX {
virtual void setDefaultClipPreferences();

/// Initialise the clip preferences arguments, override this to do
/// stuff with wierd components etc... Calls setDefaultClipPreferences
/// stuff with weird components etc... Calls setDefaultClipPreferences
virtual void setupClipPreferencesArgs(Property::Set &args);

/// Run the clip preferences action from the effect.
Expand Down
28 changes: 14 additions & 14 deletions HostSupport/include/ofxhInteract.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ namespace OFX {
};

/// a generic interact, it doesn't belong to anything in particular
/// we need to generify this slighty more and remove the renderscale args
/// we need to generify this further and remove the renderscale args
/// into a derived class, as they only belong to image effect plugins
class Instance : public Base, protected Property::GetHook {
protected:
Expand Down Expand Up @@ -148,7 +148,7 @@ namespace OFX {
// don't know what to do
virtual void reset(const std::string &name);

/// the gethook virutals for pixel scale, background colour
/// the gethook virtuals for pixel scale, background colour
virtual double getDoubleProperty(const std::string &name, int index) const;

/// for pixel scale and background colour
Expand All @@ -161,19 +161,19 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
virtual OfxStatus drawAction(OfxTime time, const OfxPointD &renderScale);

// interact action - kOfxInteractActionPenMotion
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// penX - the X position
// penY - the Y position
// pressure - the pen pressue 0 to 1
// pressure - the pen pressure 0 to 1
virtual OfxStatus penMotionAction(OfxTime time,
const OfxPointD &renderScale,
const OfxPointD &penPos,
Expand All @@ -184,11 +184,11 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// penX - the X position
// penY - the Y position
// pressure - the pen pressue 0 to 1
// pressure - the pen pressure 0 to 1
virtual OfxStatus penUpAction(OfxTime time,
const OfxPointD &renderScale,
const OfxPointD &penPos,
Expand All @@ -199,11 +199,11 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// penX - the X position
// penY - the Y position
// pressure - the pen pressue 0 to 1
// pressure - the pen pressure 0 to 1
virtual OfxStatus penDownAction(OfxTime time,
const OfxPointD &renderScale,
const OfxPointD &penPos,
Expand All @@ -214,7 +214,7 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// key - the pressed key
// keyString - the pressed key string
Expand All @@ -227,7 +227,7 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// key - the pressed key
// keyString - the pressed key string
Expand All @@ -240,7 +240,7 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
// key - the pressed key
// keyString - the pressed key string
Expand All @@ -253,7 +253,7 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
virtual OfxStatus gainFocusAction(OfxTime time,
const OfxPointD &renderScale);
Expand All @@ -262,7 +262,7 @@ namespace OFX {
//
// Params -
//
// time - the effect time at which changed occured
// time - the effect time at which changed occurred
// renderScale - the render scale
virtual OfxStatus loseFocusAction(OfxTime time,
const OfxPointD &renderScale);
Expand Down
Loading
Loading