1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/modules/juce_gui_basics/windows/juce_VBlankAttachment.h
2024-08-22 17:05:03 +02:00

85 lines
3.2 KiB
C++

/*
==============================================================================
This file is part of the JUCE framework.
Copyright (c) Raw Material Software Limited
JUCE is an open source framework subject to commercial or open source
licensing.
By downloading, installing, or using the JUCE framework, or combining the
JUCE framework with any other source code, object code, content or any other
copyrightable work, you agree to the terms of the JUCE End User Licence
Agreement, and all incorporated terms including the JUCE Privacy Policy and
the JUCE Website Terms of Service, as applicable, which will bind you. If you
do not agree to the terms of these agreements, we will not license the JUCE
framework to you, and you must discontinue the installation or download
process and cease use of the JUCE framework.
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
Or:
You may also use this code under the terms of the AGPLv3:
https://www.gnu.org/licenses/agpl-3.0.en.html
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
==============================================================================
*/
namespace juce
{
/**
Helper class to synchronise Component updates to the vertical blank event of the display that
the Component is presented on. This is useful when animating the Component's contents.
@tags{Animations}
*/
class JUCE_API VBlankAttachment final : public ComponentPeer::VBlankListener,
public ComponentListener
{
public:
/** Default constructor for creating an empty object. */
VBlankAttachment() = default;
/** Constructor. Creates an attachment that will call the passed in function at every vertical
blank event of the display that the passed in Component is currently visible on.
The Component must be valid for the entire lifetime of the VBlankAttachment.
*/
VBlankAttachment (Component* c, std::function<void()> callbackIn);
VBlankAttachment (VBlankAttachment&& other);
VBlankAttachment& operator= (VBlankAttachment&& other);
/** Destructor. */
~VBlankAttachment() override;
/** Returns true for a default constructed object. */
bool isEmpty() const { return owner == nullptr; }
//==============================================================================
void onVBlank() override;
//==============================================================================
void componentParentHierarchyChanged (Component&) override;
private:
void updateOwner();
void updatePeer();
void cleanup();
Component* owner = nullptr;
Component* lastOwner = nullptr;
std::function<void()> callback;
ComponentPeer* lastPeer = nullptr;
JUCE_DECLARE_NON_COPYABLE (VBlankAttachment)
};
} // namespace juce