JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
SyncBuffer.java
Go to the documentation of this file.
1/**
2 * Copyright 2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.math.util;
29
30import java.nio.Buffer;
31
32/**
33 * Convenient tuple of a {@link SyncAction} and {@link Buffer}.
34 * <p>
35 * {@link SyncAction#sync()} is used to update the {@link Buffer} with the underlying data
36 * known to the data provider.
37 * </p>
38 * @see SyncAction
39 */
40public interface SyncBuffer {
41 /**
42 * Return the {@link SyncAction}.
43 * @see SyncAction
44 */
46
47 /** Return the {@link Buffer}, i.e. underlying data. */
48 Buffer getBuffer();
49
50 /**
51 * Synchronizes the underlying data before usage.
52 * <p>
53 * Convenient shortcut for {@link #getAction()}.{@link SyncAction#sync() sync()} plus chaining.
54 * </p>
55 */
57
58 /** Return the {@link Buffer} after {@link SyncAction#sync() synchronizing} it. */
59 Buffer getSyncBuffer();
60
61}
Specific data synchronization action implemented by the data provider to update the buffer with the u...
Definition: SyncAction.java:38
Convenient tuple of a SyncAction and Buffer.
Definition: SyncBuffer.java:40
SyncBuffer sync()
Synchronizes the underlying data before usage.
Buffer getBuffer()
Return the Buffer, i.e.
SyncAction getAction()
Return the SyncAction.
Buffer getSyncBuffer()
Return the Buffer after synchronizing it.