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_VBlankAttachement.h
2023-02-06 10:21:37 +00:00

73 lines
2.5 KiB
C++

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2022 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 7 End-User License
Agreement and JUCE Privacy Policy.
End User License Agreement: www.juce.com/juce-7-licence
Privacy Policy: www.juce.com/juce-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR 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.
*/
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