summaryrefslogtreecommitdiffstats
path: root/src/classes/share/com/sun/j3d/internal/ByteBufferWrapper.java
blob: fe6ce6f7fd6bff83df8a9180c4afafc62667ec7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
 * $RCSfile$
 *
 * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 *
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
 * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 *
 * You acknowledge that this software is not designed, licensed or
 * intended for use in the design, construction, operation or
 * maintenance of any nuclear facility.
 *
 * $Revision$
 * $Date$
 * $State$
 */

package com.sun.j3d.internal;

import javax.media.j3d.J3DBuffer;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;

/**
 * NIO Buffers are new in Java 1.4 but we need to run on 1.3
 * as well, so this class was created to hide the NIO classes
 * from non-1.4 Java 3D users.
 *
 * <p>
 * NOTE: We no longer need to support JDK 1.3 as of the Java 3D 1.3.2
 * community source release on java.net. We should be able to get rid
 * of this class.
 */

public class ByteBufferWrapper extends BufferWrapper {

    private ByteBuffer buffer = null;

    /**
     * Constructor initializes buffer with a 
     * java.nio.ByteBuffer object.
     */
    public ByteBufferWrapper(ByteBuffer buffer) {
	this.buffer = buffer;
    }

    /**
     * Constructor initializes buffer with a
     * javax.media.j3d.J3DBuffer object.
     */
    public ByteBufferWrapper(J3DBuffer b) {
	buffer = (ByteBuffer)(b.getBuffer());
    }

    /**
     * Allocate a direct ByteBuffer with the given capacity.
     * @return New ByteBufferWrapper containing the 
     * new buffer.
     */
    public static ByteBufferWrapper allocateDirect(int capacity) {
	    ByteBuffer bb = ByteBuffer.allocateDirect(capacity);
	    return new ByteBufferWrapper(bb);
    }

    /**
     * Returns the java.nio.Buffer contained within this
     * ByteBufferWrapper.
     */
    public java.nio.Buffer getBuffer() {
	return this.buffer;
    }

    // Wrapper for all relevant ByteBuffer methods.

    /**
     * @return A boolean indicating whether the java.nio.Buffer
     * object contained within this ByteBuffer is direct or
     * indirect.
     */
    public boolean isDirect() {
	return buffer.isDirect();
    }

    /**
     * Reads the byte at this buffer's current position,
     * and then increments the position. 
     */
    public byte get() {
	return buffer.get();
    }

    /**
     * Reads the byte at the given offset into the buffer.
     */
    public byte get(int index) {
	return buffer.get(index);
    }

    /** 
     * Bulk <i>get</i> method.  Transfers <code>dst.length</code>
     * bytes from
     * the buffer to the destination array and increments the
     * buffer's position by <code>dst.length</code>.
     */
    public ByteBufferWrapper get(byte[] dst) {
	buffer.get(dst);
	return this;
    }
    
    /**
     * Bulk <i>get</i> method.  Transfers <i>length</i> bytes 
     * from the buffer starting at position <i>offset</i> into
     * the destination array.
     */
    public ByteBufferWrapper get(byte[] dst, int offset, int length) {
	buffer.get(dst, offset, length);
	return this;
    }

    /**
     * Returns the byte order of this buffer.
     */
    public ByteOrderWrapper order() {
	if ( buffer.order()==ByteOrder.BIG_ENDIAN ) return ByteOrderWrapper.BIG_ENDIAN;
	else return ByteOrderWrapper.LITTLE_ENDIAN;
    }

    /**
     * Modifies this buffer's byte order. 
     */
    public ByteBufferWrapper order(ByteOrderWrapper bo)
    {
	if ( bo == ByteOrderWrapper.BIG_ENDIAN ) buffer.order( ByteOrder.BIG_ENDIAN );
	else buffer.order( ByteOrder.LITTLE_ENDIAN );
	return this;
    }

    /** 
     * Creates a view of this ByteBufferWrapper as a
     * FloatBufferWrapper.  Uses the correct
     */
    public FloatBufferWrapper asFloatBuffer() {
	return new FloatBufferWrapper( buffer.asFloatBuffer() );
    }

    /** 
     * Creates a view of this ByteBufferWrapper as a
     * DoubleBufferWrapper.
     */
    public DoubleBufferWrapper asDoubleBuffer() {
	return new DoubleBufferWrapper( buffer.asDoubleBuffer() );
    }

    /**
     * Bulk <i>put</i> method.  Transfers <code>src.length</code>
     * bytes into the buffer at the current position.
     */
    public ByteBufferWrapper put(byte[] src) {
	buffer.put(src);
	return this;
    }

    /**
     * Creates and returns a J3DBuffer object containing the
     * buffer in this ByteBufferWrapper object.
     */
    public J3DBuffer getJ3DBuffer() {
	return new J3DBuffer( buffer );
    }
}