ofVideoGrabberfile

ofVideoGrabberclass

Attributes

height variable

int height

width variable

int width

Functions

ofVideoGrabber ()

ofVideoGrabber()

~ofVideoGrabber ()

~ofVideoGrabber()

listDevices ()

ofVideoDevice listDevices() const

Get a list of available video grabber devices.

Returns: a std::vector of ofVideoDevice objects.

Implements ofBaseVideoGrabber.

isFrameNew ()

bool isFrameNew() const

Returns: true if the pixel data was updated since the last call to update().

Implements ofBaseVideo.

update ()

void update()

Update the object's state.

Implements ofBaseUpdates.

close ()

void close()

Close the video source.

Implements ofBaseVideo.

setup ()

bool setup(int w, int h)

Set up the grabber with the requested width and height.

Some video grabbers may take the requested width and height as a hint and choose the closest dimensions to those requested. Users can check the actual width and height by calling getWidth() and getHeight() respectively after a successful setup.

Parameters

w	the requested width.
h	the requested height.

Returns: true if the video grabber was set up successfully.

Implements ofBaseVideoGrabber.

bool setup(int w, int h, bool bTexture)

OF_DEPRECATED_MSG ()

OF_DEPRECATED_MSG("Use setup instead", bool initGrabber(int w, int h){return setup(w, h);}) OF_DEPRECATED_MSG("Use setup instead"

initGrabber ()

bool initGrabber(int w, int h, bool bTexture))

setPixelFormat ()

bool setPixelFormat(ofPixelFormat pixelFormat)

Set the requested ofPixelFormat.

Parameters

pixelFormat the requested ofPixelFormat.

Returns: true if the format was successfully changed.

Implements ofBaseVideo.

getPixelFormat ()

ofPixelFormat getPixelFormat() const

Returns: the current ofPixelFormat.

Implements ofBaseVideo.

videoSettings ()

void videoSettings()

Request a native GUI for video grabber settings.

Note: This feature may not be implemented by all video grabbers.

Reimplemented from ofBaseVideoGrabber.

getPixels ()

ofPixels getPixels()

Get a reference to the underlying ofPixels.

Returns: a reference the underlying ofPixels.

Implements ofBaseHasPixels_< T >.

ofPixels getPixels() const

Get a const reference to the underlying ofPixels.

Returns: a const reference the underlying ofPixels.

Implements ofBaseHasPixels_< T >.

getPixelsRef () Use getPixels() instead

ofPixels getPixelsRef()

const ofPixels getPixelsRef()

getTexture ()

ofTexture getTexture()

Returns: a reference to the ofTexture.

Implements ofBaseHasTexture.

ofTexture getTexture() const

Returns: a const reference to the ofTexture.

Implements ofBaseHasTexture.

getTextureReference () Use getTexture

ofTexture getTextureReference()

const ofTexture getTextureReference()

getTexturePlanes ()

ofTexture getTexturePlanes()

Returns: a reference to a std::vector containing the ofTexture planes.

Implements ofBaseHasTexturePlanes.

ofTexture getTexturePlanes() const

Returns: a const reference to a std::vector containing the ofTexture planes.

Implements ofBaseHasTexturePlanes.

setVerbose ()

void setVerbose(bool bTalkToMe)

Set the video grabber's hardware verbosity level.

Parameters

bTalkToMe true if verbose grabber logging feedback is required.

Reimplemented from ofBaseVideoGrabber.

setDeviceID ()

void setDeviceID(int _deviceID)

Set the video grabber's device ID.

In most cases, a user can choose a specific grabber source by ID. This device ID information should be available to the user via the listDevices() method.

Parameters

deviceID The device ID provided by listDevices().

Reimplemented from ofBaseVideoGrabber.

setDesiredFrameRate ()

void setDesiredFrameRate(int framerate)

Set the video grabber's desired frame rate.

Many video grabbers support user-specified frame rates. This frame rate should be considered a hint for the video grabber and is not guaranteed.

Parameters

framerate the desired frame rate.

Reimplemented from ofBaseVideoGrabber.

setUseTexture ()

void setUseTexture(bool bUse)

Enable or disable internal ofTexture use.

Parameters

bUseTex true if an ofTexture should be used.

Implements ofBaseHasTexture.

isUsingTexture ()

bool isUsingTexture() const

Returns: true if an internal ofTexture is being used.

Implements ofBaseHasTexture.

draw ()

void draw(float x, float y, float w, float h) const

Draw at a position with the specified size.

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
w	Draw width.
h	Draw height.

Implements ofBaseDraws.

void draw(float x, float y) const

Draw at a position at the native size.

Native size is determined by getWidth() and getHeight().

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.

Implements ofBaseDraws.

bind ()

void bind() const

unbind ()

void unbind() const

setAnchorPercent ()

void setAnchorPercent(float xPct, float yPct)

Set the anchor point the item is drawn around as a percentage.

This can be useful if you want to rotate an image around a particular point.

Parameters

xPct	Horizontal position as a percentage (0 - 1).
yPct	Vertical position as a percentage (0 - 1).

Reimplemented from ofBaseDraws.

setAnchorPoint ()

void setAnchorPoint(float x, float y)

Set the anchor point the item is drawn around in pixels.

This can be useful if you want to rotate an image around a particular point.

Parameters

x	Horizontal texture position in pixels.
y	Vertical texture position in pixels.

Reimplemented from ofBaseDraws.

resetAnchor ()

void resetAnchor()

Reset the anchor point to (0, 0).

Reimplemented from ofBaseDraws.

getHeight ()

float getHeight() const

Get the video grabber's height.

Returns: the video grabber's height.

Implements ofBaseVideoGrabber.

getWidth ()

float getWidth() const

Get the video grabber's width.

Returns: the video grabber's width.

Implements ofBaseVideoGrabber.

isInitialized ()

bool isInitialized() const

Determine if the video source is initialized.

Video sources such as cameras are often initialized with a setup() method. Video sources such as movie players are often initialized with a load() method.

Returns: true if the video source is initialized.

Implements ofBaseVideo.

setGrabber ()

void setGrabber(shared_ptr< ofBaseVideoGrabber > newGrabber)

getGrabber ()

ofBaseVideoGrabber getGrabber()

ofBaseVideoGrabber getGrabber() const

shared_ptr< GrabberType > getGrabber()

const shared_ptr< GrabberType > getGrabber() const

getTexturePtr ()

ofTexture getTexturePtr()

Get the video grabber's internal ofTexture pointer if available.

Note: Subclasses should implement this method only if internal API can upload video grabber pixels directly to an ofTexture.

Returns: the internal ofTexture pointer or NULL if not available.

draw ()

void draw(const ofPoint &point) const

Draw at a position at the native size.

Native size is determined by getWidth() and getHeight().

Parameters

point Draw position.

void draw(const ofRectangle &rect) const

Draw at a position and size specified by a rectangle.

Parameters

rect	Draw position and size.

void draw(const ofPoint &point, float w, float h) const

Draw at a position.

Parameters

point	Draw position.
w	Draw width.
h	Draw height.